Generate a public report for a brand
create_reportGenerates a free brand visibility report and emails it to a prospect, helping agencies capture leads with a white-label sample.
Instructions
Generates the free visibility report an agency hands to a prospect, and emails it to the address given. A public report is PromptEye's lead magnet, sold to agencies white-label: a prospect fills in a form on the agency's site, PromptEye works out the industry, asks a set of assistants how visible that brand is, and emails back a page in the agency's branding — a visibility score, the competitors ahead of them, and quotes from what the assistants actually said. It is a one-off sample, not tracking: nothing is measured again until the report is converted into a project, which happens in the PromptEye app. leadStatus and the conversion are the agency's sales pipeline, and contactCount is how many times the brand asked to be contacted from the page.
The report is booked to the account the configured API key belongs to, and spends that account's lead-magnet quota. Nothing has to be asked for or passed in: the account's own id is what the public endpoint calls agencyId, and this tool reads it from the account itself. The call to PromptEye is the one that carries no API key — the endpoint is public, which is what lets an agency's website post to it straight from a form. Reach for get_report_integration when the question is how to wire that form up.
A report for the same domain and account generated in the last 30 days is not built again; it is sent to the address once more, and the result says which of the two happened. A new one comes back as processing with no score — the figures land minutes later, so read them with get_report rather than promising them straight away.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| utm | No | Campaign the lead came from; kept on the report and in its link. | |
| brand | Yes | The brand the report is about. | |
| Yes | Where the finished report is sent. The prospect's address. | ||
| reach | No | How wide the brand competes, which decides the questions asked: local, regional or national. Defaults to national. | |
| country | No | Market as an ISO 3166-1 alpha-2 code, e.g. PL. | |
| website | No | The brand's domain, without protocol. It is what a cached report is matched on. | |
| language | No | Language of the prompts, as a two-letter code. |