Starts 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, what the run is recorded as and where it is filed, which of the account's included monthly Diagnostics it uses, and a confirmation_token. A second call with that confirmation_token starts it; any change needs a new preview. When the website has versions for several countries or languages (acme.com/uk, acme.com/au), the preview lists them in site_versions, and which one is checked is the person's choice; a version is checked through a new preview with its url. A site is a domain, a subdomain or a country or language folder (acme.com/uk), and workspaces are matched by site: when a domain has workspaces for some of its folders and the address is in none of them (host_split), the run is not filed in any of them automatically, and the preview or needs_client lists them with the site each one is for. 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). file_as says what the run is for, with the same five choices as the app: my_business (the account's own website), client, competitor, research or prospect. A competitor or research run of a website no workspace holds is filed in no workspace and creates none; a website or business name a client or brand workspace holds is filed in that workspace, as in the app. On an account with workspaces (clients, prospects or brands), client_id names the workspace, and needs_client lists the candidates when where the run is filed 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 site 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.
View input schema
{
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 8192,
"description": "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."
},
"business_name": {
"type": "string",
"maxLength": 200,
"description": "The name of the business that operates the website, as the person gave it. Optional with earlier_report_id."
},
"side_a_scores": {
"type": "object",
"description": "The person's own 1-to-10 rating of each pillar, keyed attribution, tech_stack, conversion, compliance (shown to people as Trust & Security), brand, marketing, advertising, competitors, product and discoverability. A pillar left out is \"not sure\" and is entered as 5, the intake form's own default.",
"properties": {
"attribution": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"tech_stack": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"conversion": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"compliance": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"brand": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"marketing": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"advertising": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"competitors": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"product": {
"type": "integer",
"minimum": 1,
"maximum": 10
},
"discoverability": {
"type": "integer",
"minimum": 1,
"maximum": 10
}
},
"additionalProperties": false
},
"budget": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 100000000,
"description": "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."
},
"client_id": {
"type": "string",
"format": "uuid",
"description": "The client, prospect or brand workspace to file the run in. It must be a workspace of this account, and one the file_as choice may be filed in."
},
"file_as": {
"type": "string",
"enum": [
"my_business",
"client",
"competitor",
"research",
"prospect",
"own"
],
"description": "What the run is for, as the app's five choices name it, and so what it is recorded as. my_business: 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. client: filed in a client workspace; with client_name, the same person may have a new client workspace created for a site no workspace holds. competitor or research: another business, filed in no workspace, or in the client or brand workspace named by client_id or matching the website; never in a prospect workspace. 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. own is the earlier name for my_business and is still accepted. Left out, a run in a workspace is recorded by the workspace (a brand's runs as my_business), a re-check keeps the earlier report's when it fits, and a run in no workspace is recorded as research; the preview says which."
},
"prospect_name": {
"type": "string",
"maxLength": 120,
"description": "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."
},
"client_name": {
"type": "string",
"maxLength": 120,
"description": "Asks for a new client workspace with this name, for the site of the address (the domain, or its country or language folder such as acme.com/uk) when no workspace of the account holds that site. 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."
},
"earlier_report_id": {
"type": "string",
"format": "uuid",
"description": "An earlier Diagnostic of this account whose website, business name, ratings and budget fill in anything not sent."
},
"confirmation_token": {
"type": "string",
"description": "The confirmation code this tool's preview returned. Present only on the second call, which starts the run."
}
},
"additionalProperties": false
}