Start a free Diagnostic
start_diagnosticStarts a Diagnostic of a website for the signed-in person, in two calls. The first call returns a preview and starts nothing: the website, the business name, the ten 1-to-10 self-ratings (which were answered, carried over or entered as 5 for "not sure"), the monthly tools budget, where the run is filed, which of the account's included monthly Diagnostics it uses, and a confirmation_token. A second call with that token starts it; any change needs a new preview. It uses only the account's included Diagnostics: when none are left the result is quota_exhausted with the reset date and the plans page, and nothing is charged. A run takes 5 to 10 minutes and a completion email also arrives; get_run_status reports progress. earlier_report_id fills in the website, name, ratings and budget from an earlier report, for a re-check; if that run did not complete and the same person started it, starting it again once for the same website and name does not use another Diagnostic (the preview says whether it applies). On an account with workspaces (clients, prospects or brands), client_id or file_as says where the run is filed, and needs_client lists the candidates when that is not clear. For an owner or admin of an Agency-plan team account, file_as prospect on a website not yet in Prospects creates a new prospect workspace for it (named by prospect_name, else the business name); the preview says so and nothing is created before the confirmation. The same person may ask for a new client workspace for a website no workspace holds: file_as client with client_name (the new workspace's name); without client_name a miss lists the client workspaces instead. Available on connections made through an AI assistant's sign-in.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | The website to check, as the person gave it (a domain or an http/https address). Tracking parameters are removed, and the address that remains must be at most 2048 characters. Optional with earlier_report_id. | |
| budget | No | Roughly what the business spends a month on marketing tools and software, in whole US dollars. Null when unknown: it is then entered as 0, the intake form's own default. Left out, it is also entered as 0, except with earlier_report_id, where the earlier report's budget is carried over. | |
| file_as | No | What the person asked for when no client_id is sent: prospect (filed in Prospects; for an owner or admin of an Agency-plan team account, a website not yet in Prospects gets a new prospect workspace), client (with client_name, the same person may have a new client workspace created for a website no workspace holds), or own (the account's own website or one of its brands: filed in the brand's workspace when the site matches one, else in no workspace; recorded as the account's own business). A run in no workspace without own is recorded as research on another business; the preview says which. | |
| client_id | No | The client, prospect or brand workspace to file the run in. It must be a workspace of this account. | |
| client_name | No | Asks for a new client workspace with this name, for a website no workspace of the account holds. Sent only with file_as client and without client_id, and only when the person asked for a new client workspace; for an owner or admin of an Agency-plan team account. Invisible and control characters are removed; it needs a letter or digit. | |
| business_name | No | The name of the business that operates the website, as the person gave it. Optional with earlier_report_id. | |
| prospect_name | No | The name of a new prospect workspace, sent only with file_as prospect and without client_id. Left out, the business name is used. Invisible and control characters are removed; it needs a letter or digit. | |
| side_a_scores | No | The person's own 1-to-10 rating of each area, keyed attribution, tech_stack, conversion, compliance (shown to people as Trust & Security), brand, marketing, advertising, competitors, product and discoverability. An area left out is "not sure" and is entered as 5, the intake form's own default. | |
| earlier_report_id | No | An earlier Diagnostic of this account whose website, business name, ratings and budget fill in anything not sent. | |
| confirmation_token | No | The token from this tool's preview. Present only on the second call, which starts the run. |