{ "server": "https://app.flexqueries.com/mcp", "tools": [ { "name": "add_report_recipient", "title": "Request recipient confirmation", "description": "Manager only. After explicit user agreement, send a bounded confirmation invitation to one requested email address. Reports are not delivered until that recipient confirms. Suppression, opt-outs and confirmation limits apply; do not use for unsolicited outreach.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "email": { "type": "string", "maxLength": 254, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" } }, "required": [ "projectId", "email" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "add_tracking_keywords", "title": "Add tracking keywords", "description": "Add keywords to a rank tracker without immediately running a check or fetching metrics. Scheduled checks will include them and incur usage. Call estimate_rank_check, then run_rank_check when approved; refresh_tracking_metrics fetches paid metrics separately.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keywords": { "minItems": 1, "maxItems": 2000, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "required": [ "projectId", "configId", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "analyze_prompt_monitor_answer", "title": "Interpret one saved AI answer", "description": "Optional paid, bounded tool-free analysis of all frozen brands in one saved answer. Requires reviewed ceiling and stable idempotency. No new search, source fetch, model fallback or paid repair. Identical retained analysis is reused; saved-answer reads include its result. Model labels are not fact checks. Check quote availability and review supporting text.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "observationId": { "type": "string", "minLength": 1, "maxLength": 200 }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "idempotencyKey", "projectId", "configId", "observationId", "confirmedCeilingCredits" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "observationId": { "type": "string" }, "kind": { "default": "answer", "type": "string", "enum": [ "answer", "page" ] }, "snapshotId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "model": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "completed", "failed", "reconciling" ] }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brands": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "analysisId": { "type": "string" }, "domain": { "type": "string" }, "label": { "type": "string" }, "mentioned": { "type": "boolean" }, "sentiment": { "type": "string" }, "recommendationRank": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "spans": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "end": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "start", "end" ], "additionalProperties": false } } }, "required": [ "id", "analysisId", "domain", "label", "mentioned", "sentiment", "recommendationRank", "spans" ], "additionalProperties": false } } }, "required": [ "id", "observationId", "kind", "version", "model", "status", "failureCode", "completedAt", "brands" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "analyze_serp_opportunity", "title": "Analyze SERP opportunity", "description": "Score one to ten keywords using the live top 10, domain and page authority, estimated page traffic, SERP weaknesses, features, search intent, demand, and difficulty. Hosted mode deducts the displayed action price from the account balance.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keywords": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 700 }, "description": "One to ten keywords to score in one billed batch." }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "results": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "object", "properties": { "keyword": { "type": "string" }, "opportunityScore": { "type": "number" }, "opportunityLabel": { "type": "string" }, "searchVolume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "keywordDifficulty": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "intent": { "type": "string" }, "weaknessCount": { "type": "number" }, "items": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "required": [ "keyword", "opportunityScore", "opportunityLabel", "searchVolume", "keywordDifficulty", "intent", "weaknessCount", "items" ], "additionalProperties": {} } }, "required": [ "ok", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "ok": { "type": "boolean", "const": false }, "keyword": { "type": "string" }, "error": { "type": "string" } }, "required": [ "ok", "keyword", "error" ], "additionalProperties": false } ] } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "results" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "append_prompt_monitor", "title": "Add tracked prompts", "description": "Add topic-grouped prompts to an existing collection after confirming its new per-run ceiling. At most 25 active prompts and 100 saved prompts. Does not collect answers. Existing schedules use the newly approved ceiling; saved history remains unchanged.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "inventory": { "type": "object", "properties": { "topics": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "prompts": { "minItems": 1, "maxItems": 25, "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 700 } } }, "required": [ "name", "prompts" ] } }, "engines": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "string", "enum": [ "chatgpt", "gemini", "google_overview", "google_ai_mode", "claude", "perplexity" ] } }, "competitors": { "default": [], "maxItems": 5, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 2, "maxLength": 100 }, "domain": { "type": "string", "minLength": 3, "maxLength": 253 } }, "required": [ "label", "domain" ] } } }, "required": [ "topics", "engines" ] }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "configId", "expectedRevision", "inventory", "confirmedCeilingCredits" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "apply_keyword_clusters", "title": "Apply keyword clusters", "description": "Add Cluster: name tags to saved keywords in this project. Returns the number assigned. No provider charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "clusters": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 80 }, "savedKeywordIds": { "minItems": 1, "maxItems": 500, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "name", "savedKeywordIds" ] } } }, "required": [ "projectId", "clusters" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "approve_implementation_proposal", "title": "Approve current change proposal", "description": "Approve the exact current proposal revision. Only its current authorized reviewer or a permitted manager can approve. Approval does not imply that the website was changed.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "opportunityId": { "type": "string", "minLength": 1 }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "opportunityId", "revision" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "archive_project", "title": "Archive project", "description": "Archive a project, retaining saved data. The last active project cannot be archived. Requires all-project write/management permission and a stable external idempotencyKey. Free.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" }, "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." } }, "required": [ "projectId", "idempotencyKey" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "cancel_local_research", "title": "Stop new local checks", "description": "Stop unsubmitted checks. Accepted tasks finish and reconcile their original hold; useful completed work stays saved. This does not promise a blanket refund.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "runId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "compare_domain_traffic", "title": "Compare domain traffic", "description": "Compare available organic traffic estimates for supplied domains in the project market. These are provider estimates, not first-party Analytics. Paid research.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "domains": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 } }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "domains" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "create_aio_monitor", "title": "Create AI visibility monitor", "description": "Create a scheduled brand/domain monitor without an immediate check. Scheduled runs use the account balance. Agree on platforms, market, alerts and frequency first; call run_aio_monitor for an immediate paid check.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "target": { "type": "string", "minLength": 1, "maxLength": 253 }, "platforms": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "string", "enum": [ "chat_gpt", "google" ] } }, "scheduleInterval": { "default": "weekly", "type": "string", "enum": [ "weekly", "monthly", "manual" ] }, "alertsEnabled": { "default": true, "type": "boolean" }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 10 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "target", "platforms" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "create_competitor_watch", "title": "Create competitor watch", "description": "Save a quoted monitor for the project's own website. No immediate research. Weekly cadence authorizes recurring paid work within the monthly cap; require the user's explicit consent. Manual is the default choice.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "scope": { "type": "object", "properties": { "domain": { "type": "string", "minLength": 1, "maxLength": 253 }, "rivals": { "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 } }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "rankings": { "default": true, "type": "boolean" }, "links": { "default": false, "type": "boolean" }, "content": { "default": false, "type": "boolean" }, "ai": { "default": false, "type": "boolean" }, "aiHistory": { "default": false, "type": "boolean" } }, "required": [ "domain", "rivals", "locationCode", "languageCode" ] }, "cadence": { "type": "string", "enum": [ "manual", "weekly" ] }, "monthlyCapCredits": { "type": "integer", "minimum": 50, "maximum": 100000 }, "confirmedCeilingCredits": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "scope", "cadence", "monthlyCapCredits", "confirmedCeilingCredits" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "create_local_review_search", "title": "Start local review search", "description": "Starts a standard-priority Google, Trustpilot, or Tripadvisor review task. The metered task is asynchronous; collect it with get_local_review_search.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "platform": { "type": "string", "enum": [ "google", "trustpilot", "tripadvisor" ] }, "target": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Business name for Google/Tripadvisor or the business domain for Trustpilot." }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." }, "limit": { "default": 10, "type": "integer", "minimum": 1, "maximum": 20 } }, "required": [ "idempotencyKey", "projectId", "platform", "target" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "platform": { "type": "string" }, "taskId": { "type": "string" }, "target": { "type": "string" }, "status": { "type": "string", "const": "queued" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "platform", "taskId", "target", "status" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "create_merchant_product_search", "title": "Start product search", "description": "Start a Google Shopping or Amazon product search and receive a task ID for checking progress. Uses credits when started.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "platform": { "type": "string", "enum": [ "google_shopping", "amazon" ] }, "query": { "type": "string", "minLength": 1, "maxLength": 700 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." }, "limit": { "default": 20, "type": "integer", "minimum": 1, "maximum": 40 } }, "required": [ "idempotencyKey", "projectId", "platform", "query" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "platform": { "type": "string" }, "taskId": { "type": "string" }, "query": { "type": "string" }, "status": { "type": "string", "const": "queued" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "platform", "taskId", "query", "status" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "create_page_plan", "title": "Create a page plan", "description": "Save a project page or unpublished plan. url=null is unpublished and has no fabricated traffic/indexing. This does not publish to a CMS or buy research.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "type": "string", "minLength": 1, "maxLength": 250 }, "url": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] } }, "required": [ "projectId", "title", "url" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "create_project", "title": "Create project", "description": "Create a project in the current workspace. Requires workspace management, all-project access and write permission. External agents must send a stable idempotencyKey. No charge or paid research.", "inputSchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "domain": { "type": "string", "maxLength": 255 }, "country_code": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "language_code": { "type": "string", "maxLength": 10 }, "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." } }, "required": [ "name", "idempotencyKey" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" }, "name": { "type": "string" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language_code": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "domain", "country_code", "country", "language_code", "created_at" ], "additionalProperties": false } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "create_prompt_monitor", "title": "Create prompt monitor", "description": "Create topic-grouped tracking for ChatGPT/Gemini search, Google AI Overview/AI Mode, or labelled Claude/Perplexity API answers. API questions max 500 characters. Setup is free; explicitly confirm the per-run hold. Daily/weekly/monthly schedules require explicit recurring authorization. Manual setup does not run checks. Delivery, samples and optional analysis affect the quote.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "domain": { "type": "string", "minLength": 3, "maxLength": 253 }, "brandLabel": { "type": "string", "minLength": 2, "maxLength": 100 }, "aliases": { "default": [], "maxItems": 9, "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 100 } }, "countryCode": { "default": "US", "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "languageCode": { "default": "en", "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, "scheduleInterval": { "default": "manual", "type": "string", "enum": [ "manual", "daily", "weekly", "monthly" ] }, "measurement": { "type": "object", "properties": { "deliveryMode": { "default": "live", "type": "string", "enum": [ "live", "standard" ] }, "samplesPerPrompt": { "default": 1, "type": "integer", "minimum": 1, "maximum": 3 }, "chatgptSearchPolicy": { "default": "forced", "type": "string", "enum": [ "forced", "natural" ] }, "answerAnalysisEnabled": { "default": false, "type": "boolean" } }, "additionalProperties": false }, "schedule": { "type": "object", "properties": { "timeZone": { "type": "string", "minLength": 1, "maxLength": 100 }, "hour": { "type": "integer", "minimum": 0, "maximum": 23 }, "minute": { "default": 0, "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "default": 1, "type": "integer", "minimum": 0, "maximum": 6 }, "dayOfMonth": { "default": 1, "type": "integer", "minimum": 1, "maximum": 31 }, "monthlyLimitCredits": { "type": "integer", "minimum": 50, "maximum": 1000000 } }, "required": [ "timeZone", "hour", "monthlyLimitCredits" ] }, "inventory": { "type": "object", "properties": { "topics": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "prompts": { "minItems": 1, "maxItems": 25, "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 700 } } }, "required": [ "name", "prompts" ] } }, "engines": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "string", "enum": [ "chatgpt", "gemini", "google_overview", "google_ai_mode", "claude", "perplexity" ] } }, "competitors": { "default": [], "maxItems": 5, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 2, "maxLength": 100 }, "domain": { "type": "string", "minLength": 3, "maxLength": 253 } }, "required": [ "label", "domain" ] } } }, "required": [ "topics", "engines" ] }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "domain", "brandLabel", "inventory", "confirmedCeilingCredits" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "create_prompt_source_opportunity", "title": "Draft a cited-source opportunity", "description": "Free private Opportunity draft from owned retained source evidence. Deduplicates by source/website and preserves previously dismissed or implemented work. No model, research, outreach or publication.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "snapshotId": { "type": "string", "minLength": 1, "maxLength": 200 }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "configId", "snapshotId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "create_rank_tracker", "title": "Create rank tracker", "description": "Create a domain rank tracker in the project market or an explicit location. Agree on devices, depth and schedule: future scheduled checks use the account balance. Add keywords with add_tracking_keywords and run_rank_check to collect positions.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "domain": { "type": "string", "minLength": 1, "maxLength": 253 }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "maxLength": 10 }, "locationName": { "type": "string", "minLength": 1, "maxLength": 200 }, "devices": { "type": "string", "enum": [ "both", "desktop", "mobile" ] }, "serpDepth": { "type": "integer", "minimum": 10, "maximum": 100, "multipleOf": 10 }, "scheduleInterval": { "type": "string", "enum": [ "daily", "weekly", "monthly", "manual" ] }, "scheduleTime": { "type": "object", "properties": { "timeZone": { "type": "string", "minLength": 1, "maxLength": 100 }, "hour": { "type": "integer", "minimum": 0, "maximum": 23 }, "minute": { "default": 0, "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "default": 1, "type": "integer", "minimum": 0, "maximum": 6 }, "dayOfMonth": { "default": 1, "type": "integer", "minimum": 1, "maximum": 31 } }, "required": [ "timeZone", "hour" ] }, "maxRunCredits": { "type": "integer", "minimum": 0, "maximum": 100000000 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "domain", "serpDepth" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "create_saved_report_share", "title": "Create public report link", "description": "Create an expiring public link to an existing saved report. Anyone with the link can read it, including its metrics and branding. Get explicit user consent before setting confirmedPublic=true. Workspace managers only; no usage charge. The bearer link is returned only once.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "reportId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expiresInDays": { "type": "integer", "minimum": 1, "maximum": 30 }, "confirmedPublic": { "type": "boolean", "const": true } }, "required": [ "projectId", "reportId", "expiresInDays", "confirmedPublic" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "expiresAt": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": [ "id", "expiresAt", "url" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "deep_check_audit_page", "title": "Deep-check audit page", "description": "Runs an on-demand page-analysis check with page metadata, failed checks, bounded Markdown content, and structured-data validation. Uses two metered calls. Local and private-network targets are blocked.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Public HTTP(S) page URL to inspect." } }, "required": [ "projectId", "url" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "url": { "type": "string" }, "page": { "type": "object", "properties": {}, "additionalProperties": {} }, "contentMarkdown": { "type": "string" }, "structuredData": { "type": "object", "properties": {}, "additionalProperties": {} }, "competitor": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "recommendations": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "fetchedAt": { "type": "string" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "url", "page", "contentMarkdown", "structuredData", "competitor", "recommendations", "fetchedAt" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "delete_audit_schedule", "title": "Delete audit schedule", "description": "Remove a project audit schedule. Confirm the schedule with the user first.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "scheduleId": { "type": "string", "minLength": 1 } }, "required": [ "projectId", "scheduleId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "delete_content_brief", "title": "Delete a content brief", "description": "Delete a saved brief and its draft from this project. Confirm the specific brief with the user first.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "briefId": { "type": "string", "minLength": 1 } }, "required": [ "projectId", "briefId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "delete_keyword_tag", "title": "Delete keyword tag", "description": "Delete a tag from this project’s keywords. Confirm the tag first. No provider charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "tagId": { "type": "string", "minLength": 1 } }, "required": [ "projectId", "tagId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "delete_site_audit", "title": "Delete site audit", "description": "Delete an audit and its stored results. Confirm the specific audit before calling. Uses the dashboard’s cancellation and billing handling for active jobs.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "auditId": { "type": "string", "minLength": 1 } }, "required": [ "projectId", "auditId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "edit_page_plan", "title": "Edit or publish a page plan", "description": "Update the current saved version using expectedUpdatedAt. Attaching an unpublished plan to an existing URL merges targets/work without overwriting the live primary target. Does not edit the actual website.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "pageId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedUpdatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "title": { "type": "string", "minLength": 1, "maxLength": 250 }, "url": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "reviewAt": { "anyOf": [ { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, { "type": "null" } ] } }, "required": [ "projectId", "pageId", "expectedUpdatedAt", "title", "url", "reviewAt" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "edit_prompt_monitor_text", "title": "Revise prompt wording", "description": "Create a new semantic prompt version and archive earlier wording while retaining its answers. Requires revision and reviewed future-run ceiling. Free save; does not collect answers.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "promptId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "text": { "type": "string", "minLength": 3, "maxLength": 700 }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "configId", "expectedRevision", "promptId", "text", "confirmedCeilingCredits" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "estimate_rank_check", "title": "Estimate rank check cost", "description": "Estimate the next check for a configured tracker without starting or charging for it. Use before run_rank_check.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "configId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "explore_prompt", "title": "Explore AI answers", "description": "Run a prompt against selected ChatGPT, Claude, Gemini or Perplexity models. Returns answers, citations, fan-out queries, brand matches and per-model failures. Paid provider requests use the account balance; agree on models and budget first.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "prompt": { "type": "string", "minLength": 1, "maxLength": 500 }, "models": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "chat_gpt", "claude", "gemini", "perplexity" ] } }, "highlightBrand": { "type": "string", "minLength": 1, "maxLength": 250 }, "webSearch": { "default": true, "type": "boolean" }, "webSearchCountryCode": { "type": "string", "enum": [ "US", "GB", "CA", "AU", "IE", "DE", "FR", "ES", "IT", "NL", "PT", "PL", "SE", "NO", "DK", "BR", "MX", "IN", "JP", "KR", "SG", "HK", "TW", "ZA" ] } }, "required": [ "projectId", "prompt", "models" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "export_saved_report", "title": "Download saved report", "description": "Export an immutable saved report to branded PDF, Word (DOCX), or one CSV table. Returns base64 bytes; decode locally. No credits, public share link or paid refresh. Files are bounded to 700 KB. Google-derived legacy sections are omitted because their property provenance is unknown. Table indexes start at zero.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "report_id": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" }, "format": { "type": "string", "enum": [ "pdf", "docx", "csv" ] }, "table_index": { "default": 0, "type": "integer", "minimum": 0, "maximum": 20 }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } }, "required": [ "report_id", "format", "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filename": { "type": "string" }, "mime_type": { "type": "string" }, "encoding": { "type": "string", "const": "base64" }, "content": { "type": "string" }, "byte_length": { "type": "integer", "minimum": 0, "maximum": 700000 }, "omitted_sections": { "type": "array", "items": { "type": "string" } }, "snapshot_at": { "type": "string" } }, "required": [ "filename", "mime_type", "encoding", "content", "byte_length", "omitted_sections", "snapshot_at" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "find_amazon_competitors", "title": "Find Amazon search competitors", "description": "Find ASINs competing for the same Amazon searches. Uses credits based on the requested result limit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "asin": { "type": "string", "pattern": "^[A-Za-z0-9]{10}$", "description": "A 10-character Amazon ASIN." }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "asin" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "mode": { "type": "string", "const": "competitors" }, "totalCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "competitors": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" }, "averagePosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "intersections": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "metrics": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "top1": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top3": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top10": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top100": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalKeywords": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "searchVolume": { "type": "number", "minimum": 0 } }, "required": [ "top1", "top3", "top10", "top100", "totalKeywords", "searchVolume" ], "additionalProperties": false } } }, "required": [ "asin", "averagePosition", "intersections", "metrics" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "mode", "totalCount", "competitors" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "find_app_store_competitors", "title": "Find app-store search competitors", "description": "Find apps competing for the same store-search keywords. Uses credits based on the requested result limit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "store": { "type": "string", "enum": [ "google_play", "app_store" ] }, "appId": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Google Play package name or Apple App Store numeric app ID." }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "store", "appId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "mode": { "type": "string", "const": "competitors" }, "totalCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "competitors": { "type": "array", "items": { "type": "object", "properties": { "appId": { "type": "string" }, "averagePosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "intersections": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "metrics": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "top1": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top3": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top10": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top100": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalKeywords": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "searchVolume": { "type": "number", "minimum": 0 } }, "required": [ "top1", "top3", "top10", "top100", "totalKeywords", "searchVolume" ], "additionalProperties": false } } }, "required": [ "appId", "averagePosition", "intersections", "metrics" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "mode", "totalCount", "competitors" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "find_serp_competitors", "title": "Find SERP competitors", "description": "Compares domains competing in Google results for a supplied keyword set. Useful for market and search-intelligence reports; not radius-based local SEO. Charges credits.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keywords": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": "Keywords whose SERPs are compared (1-100)." }, "market": { "description": "Optional market object. Omitted = the project's default market (United States unless the project overrides it).", "type": "object", "properties": { "country": { "description": "ISO country selector, such as US, GB or DE. US name aliases remain supported.", "anyOf": [ { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, { "type": "string", "enum": [ "USA", "United States", "United States of America" ] } ] } } }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." }, "resultTypes": { "description": "SERP result types to include. Defaults to organic and local_pack.", "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "organic", "paid", "featured_snippet", "local_pack" ] } }, "excludeDomains": { "description": "Domains to exclude from results (e.g. the user's own site).", "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 255 } }, "includeSubdomains": { "description": "Count subdomains as part of the same competitor domain.", "type": "boolean" }, "sortBy": { "description": "Sort order for returned competitors. Defaults to visibility.", "type": "string", "enum": [ "visibility", "traffic_estimate", "avg_position", "keyword_count" ] }, "limit": { "description": "Maximum competitors to return (1-100). Defaults to 50.", "type": "integer", "minimum": 1, "maximum": 100 }, "offset": { "description": "Rows to skip for pagination.", "type": "integer", "minimum": 0, "maximum": 1000 } }, "required": [ "projectId", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "competitors": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "competitors" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "generate_content_brief", "title": "Generate a content brief", "description": "Create and save a SERP-informed content brief using the project market and saved keywords. Paid SERP and AI generation use the account balance; obtain user agreement before running.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "targetKeyword": { "type": "string", "minLength": 2, "maxLength": 200 }, "audience": { "type": "string", "minLength": 2, "maxLength": 300 }, "notes": { "type": "string", "maxLength": 2000 } }, "required": [ "projectId", "targetKeyword", "audience" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_advanced_analytics_report", "title": "Read an Analytics report", "description": "Free, read-only acquisition, campaigns, ecommerce items/landing pages, site search and aggregated audience reports. Property access and metric compatibility are checked. Missing measurement is not zero. Dates follow the returned property timezone; quota and bounded pagination apply.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "start_date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "end_date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "limit": { "default": 100, "type": "integer", "minimum": 1, "maximum": 500 }, "offset": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "kind": { "type": "string", "enum": [ "acquisition", "campaigns", "ecommerce_items", "ecommerce_landing", "site_search", "audience_device", "audience_country", "audience_returning" ] }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } }, "required": [ "start_date", "end_date", "kind", "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_agent_operation", "title": "Recover an agent operation", "description": "Read a persisted audit, rank-check or AI-monitor start by operationId. Free; never launches replacement work. Use the returned audit/run ID with the feature's status tool.", "inputSchema": { "type": "object", "properties": { "operationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "operationId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "operationId": { "type": "string" }, "tool": { "type": "string" }, "state": { "type": "string", "enum": [ "running", "succeeded", "failed", "indeterminate" ] }, "createdAt": { "type": "string" }, "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "result": { "anyOf": [ { "$ref": "#/definitions/__schema0" }, { "type": "null" } ] } }, "required": [ "operationId", "tool", "state", "createdAt", "completedAt", "result" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_aio_monitoring", "title": "Get AI visibility monitoring", "description": "Read scheduled ChatGPT and Google AI Overview visibility monitors, latest run status and saved mention history. Uses no credits. Use create_aio_monitor, update_aio_monitor and run_aio_monitor to manage them. History describes saved snapshots; latestRun identifies pending or failed checks.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "limit": { "description": "History snapshots to return (default 52, maximum 104).", "type": "integer", "minimum": 1, "maximum": 104 }, "monitorId": { "description": "AI visibility monitor ID. Omit to list monitors; provide it to read snapshot history.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "monitors": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "monitor": { "type": "object", "properties": {}, "additionalProperties": {} }, "history": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_amazon_keyword_intersection", "title": "Compare Amazon product keywords", "description": "Compare shared keyword rankings for two to 10 ASINs. Uses credits based on the requested result limit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "asins": { "minItems": 2, "maxItems": 10, "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z0-9]{10}$", "description": "A 10-character Amazon ASIN." } }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "asins" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "mode": { "type": "string", "const": "intersection" }, "totalCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "keywords": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "searchVolume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rankings": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } } }, "required": [ "keyword", "searchVolume", "rankings" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "mode", "totalCount", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_amazon_keyword_volumes", "title": "Get Amazon keyword volumes", "description": "Compare Amazon monthly search-volume estimates for up to 100 keywords. Uses credits based on the number of keywords requested.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keywords": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 700 }, "description": "One to 100 Amazon search terms." }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "fetchedAt": { "type": "string" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "keywords", "fetchedAt" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_amazon_rank_overview", "title": "Get Amazon rank overview", "description": "Compare keyword-ranking coverage and aggregate demand for up to 20 ASINs. Uses credits based on the number of products requested.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "asins": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z0-9]{10}$", "description": "A 10-character Amazon ASIN." } }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "asins" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "mode": { "type": "string", "const": "rank_overview" }, "products": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" }, "metrics": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "top1": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top3": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top10": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top100": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalKeywords": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "searchVolume": { "type": "number", "minimum": 0 } }, "required": [ "top1", "top3", "top10", "top100", "totalKeywords", "searchVolume" ], "additionalProperties": false } } }, "required": [ "asin", "metrics" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "mode", "products" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_amazon_ranked_keywords", "title": "Get Amazon product keywords", "description": "Find the keywords an ASIN ranks for, including position and search-demand metrics. Uses credits based on the requested result limit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "asin": { "type": "string", "pattern": "^[A-Za-z0-9]{10}$", "description": "A 10-character Amazon ASIN." }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "asin" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "related_keywords", "ranked_keywords" ] }, "totalCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "keywords": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "searchVolume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cpc": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "competition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rank": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "relatedKeywords": { "type": "array", "items": { "type": "string" } } }, "required": [ "keyword", "searchVolume", "cpc", "competition", "rank", "relatedKeywords" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "mode", "totalCount", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_amazon_related_keywords", "title": "Get related Amazon keywords", "description": "Expand an Amazon seed into related shopping searches with demand metrics. Uses credits based on the requested result limit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keyword": { "type": "string", "minLength": 1, "maxLength": 700 }, "depth": { "default": 1, "description": "Related-keyword expansion depth, from direct to broader terms.", "type": "integer", "minimum": 0, "maximum": 4 }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "keyword" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "related_keywords", "ranked_keywords" ] }, "totalCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "keywords": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "searchVolume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cpc": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "competition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rank": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "relatedKeywords": { "type": "array", "items": { "type": "string" } } }, "required": [ "keyword", "searchVolume", "cpc", "competition", "rank", "relatedKeywords" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "mode", "totalCount", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_analytics_measurement_health", "title": "Check Analytics measurement", "description": "Read-only Google stream/key-event configuration and bounded aggregate event observations. Configured does not prove a tag fires or sales are complete. Unknown measurement is not zero. No Google settings are changed and no research credits are spent.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "checked_at": { "type": "string" }, "period": { "type": "object", "properties": { "start": { "type": "string", "const": "28daysAgo" }, "end": { "type": "string", "const": "yesterday" } }, "required": [ "start", "end" ], "additionalProperties": false }, "checks": { "maxItems": 5, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "web_stream", "key_events", "enhanced_measurement", "site_search", "ecommerce" ] }, "label": { "type": "string" }, "state": { "type": "string", "enum": [ "configured", "missing", "observed", "unknown" ] }, "detail": { "type": "string" } }, "required": [ "key", "label", "state", "detail" ], "additionalProperties": false } }, "web_streams": { "maxItems": 200, "type": "array", "items": { "type": "string" } }, "key_events": { "maxItems": 100, "type": "array", "items": { "type": "string" } }, "event_window_complete": { "type": "boolean" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "time_zone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "note": { "type": "string" } }, "required": [ "checked_at", "period", "checks", "web_streams", "key_events", "event_window_complete", "currency", "time_zone", "note" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_analytics_report", "title": "Get Google Analytics report", "description": "Read connected GA4 data: current and previous 28-day periods, sessions, users, page views, events, key events, and top 20 landing pages. No FlexQueries usage charge. report=null means GA4 is not connected; connect it in the dashboard. Values and period boundaries are returned as stored, not estimates.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "report": { "anyOf": [ { "type": "object", "properties": { "period": { "type": "object", "properties": { "startDate": { "type": "string" }, "endDate": { "type": "string" }, "previousStartDate": { "type": "string" }, "previousEndDate": { "type": "string" } }, "required": [ "startDate", "endDate", "previousStartDate", "previousEndDate" ], "additionalProperties": false }, "totals": { "type": "object", "properties": { "activeUsers": { "type": "number" }, "sessions": { "type": "number" }, "pageViews": { "type": "number" }, "events": { "type": "number" }, "keyEvents": { "type": "number" } }, "required": [ "activeUsers", "sessions", "pageViews", "events", "keyEvents" ], "additionalProperties": false }, "previousTotals": { "type": "object", "properties": { "activeUsers": { "type": "number" }, "sessions": { "type": "number" }, "pageViews": { "type": "number" }, "events": { "type": "number" }, "keyEvents": { "type": "number" } }, "required": [ "activeUsers", "sessions", "pageViews", "events", "keyEvents" ], "additionalProperties": false }, "landingPages": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "sessions": { "type": "number" }, "activeUsers": { "type": "number" }, "keyEvents": { "type": "number" } }, "required": [ "path", "sessions", "activeUsers", "keyEvents" ], "additionalProperties": false } } }, "required": [ "period", "totals", "previousTotals", "landingPages" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "report" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_app_store_keyword_intersection", "title": "Compare app-store keyword rankings", "description": "Compare shared keyword rankings for two to 10 apps. Uses credits based on the requested result limit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "store": { "type": "string", "enum": [ "google_play", "app_store" ] }, "appIds": { "minItems": 2, "maxItems": 10, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Google Play package name or Apple App Store numeric app ID." } }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "store", "appIds" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "mode": { "type": "string", "const": "intersection" }, "totalCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "keywords": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "searchVolume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rankings": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } } }, "required": [ "keyword", "searchVolume", "rankings" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "mode", "totalCount", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_app_store_metrics", "title": "Get app-store ranking metrics", "description": "Compare keyword-ranking coverage and aggregate search demand for up to 20 apps. Uses credits based on the number of apps requested.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "store": { "type": "string", "enum": [ "google_play", "app_store" ] }, "appIds": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Google Play package name or Apple App Store numeric app ID." } }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "store", "appIds" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "mode": { "type": "string", "const": "metrics" }, "apps": { "type": "array", "items": { "type": "object", "properties": { "appId": { "type": "string" }, "metrics": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "top1": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top3": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top10": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "top100": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalKeywords": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "searchVolume": { "type": "number", "minimum": 0 } }, "required": [ "top1", "top3", "top10", "top100", "totalKeywords", "searchVolume" ], "additionalProperties": false } } }, "required": [ "appId", "metrics" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "mode", "apps" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_app_store_ranked_keywords", "title": "Get app-store ranked keywords", "description": "Find the keywords an app ranks for, including position and search-demand metrics. Uses credits based on the requested result limit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "store": { "type": "string", "enum": [ "google_play", "app_store" ] }, "appId": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Google Play package name or Apple App Store numeric app ID." }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "store", "appId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "mode": { "type": "string", "const": "keywords" }, "totalCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "keywords": { "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "searchVolume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cpc": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "competition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rank": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "keyword", "searchVolume", "cpc", "competition", "rank" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "mode", "totalCount", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_audit_issues", "title": "Get site audit issues", "description": "Read the prioritized issue report from a completed site audit. Every issue carries a how_to_fix with concrete remediation steps an agent can act on. Free — reads FlexQueries state. Omit auditId for the most recent audit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "auditId": { "description": "Audit ID. If omitted, uses the project's most recent audit.", "type": "string" }, "offset": { "description": "Row offset (default 0). Continue with nextOffset while hasMore is true; reuse the returned auditId.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "severity": { "description": "Only return issues of this severity.", "type": "string", "enum": [ "critical", "warning", "info" ] }, "issueType": { "description": "Only return issues of this type. One of: blocked-page, server-error, broken-internal-link, broken-external-link, ai-crawler-blocked, missing-security-headers, mixed-content, client-rendered-shell, internal-link-opportunity, unclear-link-text, nofollow-internal-links, missing-title, broken-page, duplicate-title, duplicate-meta-description, duplicate-content, missing-meta-description, missing-h1, multiple-h1, redirect-chain, redirect-loop, canonical-conflict, thin-content, images-missing-alt, orphan-page, no-outgoing-links, title-too-long, title-too-short, meta-description-too-long, meta-description-too-short, heading-order-skip, slow-response, noindex-page, canonicalized-page, deep-page", "type": "string" }, "limit": { "description": "Max issues to return (default 200).", "type": "integer", "minimum": 1, "maximum": 1000 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "summary": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "issues": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "auditId": { "type": "string" }, "total": { "type": "number" }, "hasMore": { "type": "boolean" }, "nextOffset": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "summary", "issues", "auditId", "total", "hasMore", "nextOffset" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_audit_pages", "title": "Get site audit pages", "description": "List crawled pages from a site audit with per-page SEO data (status, title, description, word count, indexability, crawl depth, link counts). Free — reads FlexQueries state. Omit auditId for the most recent audit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "auditId": { "description": "Audit ID. If omitted, uses the project's most recent audit.", "type": "string" }, "offset": { "description": "Row offset (default 0). Continue with nextOffset while hasMore is true; reuse the returned auditId.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "fetchClass": { "description": "Filter by fetch outcome (\"blocked\" = the site's bot protection challenged the crawler).", "type": "string", "enum": [ "ok", "blocked", "error" ] }, "statusCode": { "description": "Filter by exact HTTP status code.", "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "urlContains": { "description": "Filter to URLs containing this substring.", "type": "string" }, "limit": { "description": "Max pages to return (default 100).", "type": "integer", "minimum": 1, "maximum": 1000 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "pages": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "total": { "type": "number" }, "auditId": { "type": "string" }, "hasMore": { "type": "boolean" }, "nextOffset": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "pages", "total", "auditId", "hasMore", "nextOffset" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_audit_progress", "title": "Get audit crawl progress", "description": "Read detailed crawl progress for a project audit. No provider charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "auditId": { "type": "string", "minLength": 1 } }, "required": [ "projectId", "auditId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_audit_results", "title": "Get audit overview and performance", "description": "Read a saved audit’s overview, statistics and Lighthouse performance summaries as shown in the dashboard. No provider charge. Use paginated get_audit_pages and get_audit_issues for detail.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "auditId": { "type": "string", "minLength": 1 } }, "required": [ "projectId", "auditId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_audit_status", "title": "Get site audit status", "description": "Check the progress of a site audit (phase, pages crawled, Lighthouse progress). Free — reads FlexQueries state. Omit auditId for the most recent audit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "auditId": { "description": "Audit ID. If omitted, uses the project's most recent audit.", "type": "string" } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "status": { "type": "object", "properties": {}, "additionalProperties": {} }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "status" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_backlink_depth", "title": "Get advanced backlink analysis", "description": "Returns bounded anchor distribution, backlink competitors, target spam score, and monthly new/lost history. Uses up to four metered requests.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain or absolute page URL to analyze." }, "scope": { "type": "string", "enum": [ "page", "folder", "host", "domain" ] } }, "required": [ "projectId", "target" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "target": { "type": "string" }, "spamScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "anchors": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "competitors": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "newLostTrend": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "target", "spamScore", "anchors", "competitors", "newLostTrend" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_backlink_gap", "title": "Get backlink link gap", "description": "Finds up to 50 referring domains that link to selected competitors but not the target. Uses one metered request.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain or absolute page URL to analyze." }, "scope": { "type": "string", "enum": [ "page", "folder", "host", "domain" ] }, "competitors": { "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "description": "One to three competitor domains." } }, "required": [ "projectId", "target", "competitors" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "target": { "type": "string" }, "competitors": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "totalCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "target", "competitors", "rows", "totalCount" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_backlink_networks", "title": "Get referring backlink networks", "description": "Group a target's referring links by IP or subnet to spot network concentration. Uses credits when called.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain or absolute page URL to analyze." }, "networkType": { "default": "subnet", "description": "Group referring links by individual IP or network subnet.", "type": "string", "enum": [ "ip", "subnet" ] }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "projectId", "target" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "totalCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "networks": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "backlinks": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "brokenBacklinks": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "referringDomains": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "referringPages": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "referringIps": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "referringSubnets": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "address", "rank", "backlinks", "brokenBacklinks", "referringDomains", "referringPages", "referringIps", "referringSubnets" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "totalCount", "networks" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_backlink_page_gap", "title": "Get exact-page backlink gap", "description": "Find sources linking to selected competitor pages and see which page received each link. Uses credits based on the requested result limit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "pages": { "minItems": 2, "maxItems": 10, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain or absolute page URL to analyze." }, "description": "Two to 10 exact page URLs to compare." }, "excludePages": { "default": [], "description": "Optional exact pages to exclude.", "maxItems": 5, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain or absolute page URL to analyze." } }, "mode": { "default": "partial", "description": "Require a source to link to all pages or any subset.", "type": "string", "enum": [ "all", "partial" ] }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "projectId", "pages" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "totalCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "rows": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "intersections": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sources": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "page": { "type": "string" }, "fromDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fromUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "toUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "dofollow": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "anchor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "page", "fromDomain", "fromUrl", "toUrl", "rank", "dofollow", "anchor" ], "additionalProperties": false } } }, "required": [ "intersections", "sources" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "totalCount", "rows" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_backlink_timeseries", "title": "Get backlink history", "description": "Track backlink and referring-domain totals for a domain over time. Uses credits based on the requested date range.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain or absolute page URL to analyze." }, "dateFrom": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Start date (YYYY-MM-DD), no earlier than 2019-01-30." }, "dateTo": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "End date (YYYY-MM-DD), no later than today." }, "groupRange": { "default": "month", "description": "History aggregation interval.", "type": "string", "enum": [ "day", "week", "month", "year" ] } }, "required": [ "projectId", "target", "dateFrom", "dateTo" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "points": { "maxItems": 2500, "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "backlinks": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "nofollowBacklinks": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "referringPages": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "referringDomains": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "referringMainDomains": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "referringIps": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "referringSubnets": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "date", "rank", "backlinks", "nofollowBacklinks", "referringPages", "referringDomains", "referringMainDomains", "referringIps", "referringSubnets" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "points" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_backlinks_overview", "title": "Get backlinks overview", "description": "Returns a backlinks profile summary (total backlinks, referring domains, top referring domains). Deducts the action price from the account balance.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "target": { "type": "string", "minLength": 1, "description": "Domain or URL to analyze (e.g. 'example.com' or 'https://example.com/blog')." }, "scope": { "description": "Scopes: page preserves the exact URL and query; folder uses a URL ending in /; host includes only this host; domain includes subdomains (legacy default for bare domains). Only domain has historical trends.", "type": "string", "enum": [ "page", "folder", "host", "domain" ] }, "hideSpam": { "description": "Filter out spammy referring domains. Defaults to true.", "type": "boolean" } }, "required": [ "projectId", "target" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "overview": { "type": "object", "properties": {}, "additionalProperties": {} }, "referringDomains": { "type": "object", "properties": {}, "additionalProperties": {} }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "overview", "referringDomains" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_backlinks_profile", "title": "Get backlinks profile", "description": "Returns one bounded page of detailed backlink rows for a domain or page: linking URLs, target URLs, anchors, dofollow/nofollow, authority/spam signals, and lost/broken status. Supports filters, sorting, grouping, and pagination. Deducts the action price from the account balance.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain or URL to analyze (e.g. 'example.com' or 'https://example.com/blog')." }, "scope": { "description": "Scopes: page preserves the exact URL and query; folder uses a URL ending in /; host includes only this host; domain includes subdomains (legacy default for bare domains). Only domain has historical trends.", "type": "string", "enum": [ "page", "folder", "host", "domain" ] }, "page": { "default": 1, "description": "1-indexed results page. Defaults to 1.", "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "pageSize": { "default": 100, "description": "Rows per page. Allowed values: 50, 100, or 200.", "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sortField": { "default": "rank", "description": "Backlink row sort field.", "type": "string", "enum": [ "rank", "domainRank", "spamScore", "firstSeen" ] }, "sortOrder": { "default": "desc", "description": "Sort direction.", "type": "string", "enum": [ "asc", "desc" ] }, "filters": { "description": "Backlink row filters: include/exclude source URL terms, authority/spam ranges, dofollow/nofollow, lost/broken visibility, or exact domainFrom.", "type": "object", "properties": { "include": { "type": "string" }, "exclude": { "type": "string" }, "minDomainRank": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxDomainRank": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minLinkAuthority": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxLinkAuthority": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minSpamScore": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxSpamScore": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "linkType": { "type": "string", "enum": [ "dofollow", "nofollow" ] }, "hideLost": { "type": "boolean" }, "hideBroken": { "type": "boolean" }, "domainFrom": { "type": "string", "maxLength": 255 } } }, "grouping": { "description": "Choose each referring domain's strongest link (default), or individual links.", "type": "string", "enum": [ "strongest_per_domain", "all_links" ] }, "mode": { "description": "Deprecated grouping alias for existing clients. Prefer grouping.", "deprecated": true, "type": "string", "enum": [ "one_per_domain", "as_is" ] }, "hideSpam": { "description": "Filter out spammy backlinks. Defaults to true.", "type": "boolean" } }, "required": [ "projectId", "target" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "backlinks": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "totalCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "hasMore": { "type": "boolean" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "fetchedAt": { "type": "string" } }, "required": [ "rows", "totalCount", "hasMore", "page", "pageSize" ], "additionalProperties": {} }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "backlinks" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_business_outcomes", "title": "Read organic outcomes or AI referrals", "description": "Read project GA4 organic or identifiable AI-referral sessions and selected event counts over 7, 28 or 90 days. Events are not unique leads; AI referrals are not bot crawl visits. Nulls, partials and currency caveats must be preserved. Uses connected Google access; no FlexQueries usage charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "view": { "type": "string", "enum": [ "organic", "ai_referrals" ] }, "days": { "default": 28, "anyOf": [ { "type": "number", "const": 7 }, { "type": "number", "const": 28 }, { "type": "number", "const": 90 } ] }, "source": { "default": "", "type": "string", "maxLength": 100 }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "view", "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_chatgpt_snapshot", "title": "Get ChatGPT snapshot", "description": "Runs one bounded ChatGPT scraper request and returns the rendered answer, cited sources, retrieved searches, fan-out queries, and brand entities.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "prompt": { "type": "string", "minLength": 1, "maxLength": 500 }, "forceWebSearch": { "default": true, "description": "Ask ChatGPT to use current web sources.", "type": "boolean" } }, "required": [ "projectId", "prompt" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "prompt": { "type": "string" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "markdown": { "type": "string" }, "sources": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "retrievedResults": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "fanOutQueries": { "type": "array", "items": { "type": "string" } }, "brands": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "prompt", "model", "markdown", "sources", "retrievedResults", "fanOutQueries", "brands" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_competitor_watch", "title": "Read saved competitor watches", "description": "Read project watches, saved run history, findings and current bounded quotes. Does not buy research or refresh results.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "watchId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_competitor_watch_run", "title": "Read a saved competitor run", "description": "Read saved observations, comparison evidence, check failures and actual settled charges. No new research is purchased.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "watchId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "watchId", "runId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_content_brief", "title": "Get a content brief", "description": "Read a saved brief with its outline, terms, draft and score. No usage charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "briefId": { "type": "string", "minLength": 1 } }, "required": [ "projectId", "briefId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_content_gap", "title": "Get domain content gap", "description": "Compare keyword coverage between domains. Returns one page of the dashboard content-gap table (50 rows); use page to continue. Paid research.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "yourDomain": { "type": "string", "minLength": 1, "maxLength": 253 }, "competitorDomain": { "type": "string", "minLength": 1, "maxLength": 253 }, "mode": { "default": "gap", "type": "string", "enum": [ "gap", "shared" ] }, "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 20 }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "yourDomain", "competitorDomain" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_content_workspace", "title": "Get Content Studio workspace", "description": "Read saved content briefs, keyword clusters, and internal-link suggestions for this project. No usage charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_domain_competitors", "title": "Get domain competitors", "description": "Find domains sharing organic keywords in the selected market. Paid research uses the account balance.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "domain": { "type": "string", "minLength": 1, "maxLength": 253 }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "domain" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_domain_intelligence", "title": "Get domain technology and WHOIS", "description": "Identify a domain's technology stack and public registration details. Uses credits for both checks.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "domain": { "description": "Domain to inspect, for example example.com.", "type": "string", "minLength": 1, "maxLength": 253 } }, "required": [ "projectId", "domain" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "domain": { "type": "string" }, "technologies": { "type": "object", "properties": {}, "additionalProperties": {} }, "whois": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "domain", "technologies", "whois" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_domain_keyword_suggestions", "title": "Get domain keyword opportunities", "description": "Returns the organic keywords a domain ranks for, including position and available metrics. Use after get_domain_overview when you want the detailed keyword opportunity list for a competitor or reference domain. Hosted mode deducts the action price from the account balance.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "domain": { "type": "string", "minLength": 1, "description": "Competitor or reference domain to extract keywords from." }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "domain" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_domain_keywords", "title": "Get domain keyword table", "description": "Read the dashboard’s paginated keyword table with filters, sorting, positions, intent and metrics. Paid research; respects the project market. Preserve returned pagination when requesting later pages.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "domain": { "type": "string", "minLength": 1, "maxLength": 255 }, "includeSubdomains": { "default": true, "type": "boolean" }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "page": { "default": 1, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "pageSize": { "default": 100, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sortMode": { "default": "traffic", "type": "string", "enum": [ "rank", "traffic", "volume", "score", "cpc" ] }, "sortOrder": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "filters": { "type": "object", "properties": { "include": { "type": "string" }, "exclude": { "type": "string" }, "minTraffic": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxTraffic": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minVol": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxVol": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minCpc": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxCpc": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minKd": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxKd": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minRank": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxRank": { "anyOf": [ { "type": "number" }, { "type": "string" } ] } } }, "search": { "type": "string" }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "domain" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_domain_overview", "title": "Get domain overview", "description": "Returns a high-level view of a domain's organic footprint: estimated organic traffic, organic keyword count, backlinks, and referring domains. Use this first for domain research; for the detailed ranked-keyword list, call get_domain_keyword_suggestions next. Hosted mode deducts the action price from the account balance.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "domain": { "type": "string", "minLength": 1, "description": "Domain to analyze (e.g. 'example.com')." }, "includeSubdomains": { "default": false, "description": "Legacy compatibility flag. Overview metrics and trends remain domain-wide; exact-host scope is supported by ranked-keyword and page tables, not this aggregate endpoint.", "deprecated": true, "type": "boolean" }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "domain" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "domain": { "type": "string" }, "organicTraffic": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "organicKeywords": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "backlinks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "referringDomains": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_domain_pages", "title": "Get domain top pages", "description": "Read paginated top organic pages with keyword and traffic metrics, using the same filters and market as the dashboard. Paid research.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "domain": { "type": "string", "minLength": 1, "maxLength": 255 }, "includeSubdomains": { "default": true, "type": "boolean" }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "page": { "default": 1, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "pageSize": { "default": 100, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sortMode": { "default": "traffic", "type": "string", "enum": [ "traffic", "keywords" ] }, "sortOrder": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "filters": { "type": "object", "properties": { "include": { "type": "string" }, "exclude": { "type": "string" }, "minTraffic": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxTraffic": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minVol": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxVol": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minCpc": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxCpc": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minKd": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxKd": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "minRank": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "maxRank": { "anyOf": [ { "type": "number" }, { "type": "string" } ] } } }, "search": { "type": "string" }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "domain" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_domain_visibility_history", "title": "Get domain visibility history", "description": "Read historical organic visibility estimates for a domain in the project market. Paid research. Preserve dates and missing values rather than treating them as zero.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "domain": { "type": "string", "minLength": 1, "maxLength": 255 }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "domain" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_google_ai_mode", "title": "Get Google AI Mode results", "description": "See Google's AI Mode answer and the sources it cites for one query. Uses credits when called.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keyword": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Keyword or query to research." }, "device": { "default": "desktop", "type": "string", "enum": [ "desktop", "mobile" ] }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "keyword" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "keyword": { "type": "string" }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "summaryMarkdown": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "references": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "source", "domain", "url", "title", "text" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "keyword", "checkedAt", "summaryMarkdown", "references" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_google_autocomplete", "title": "Get Google autocomplete suggestions", "description": "Discover the phrases Google suggests from one seed query. Uses credits when called.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keyword": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Keyword or query to research." }, "cursorPointer": { "description": "Optional cursor position within the query.", "type": "integer", "minimum": 0, "maximum": 700 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "keyword" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "keyword": { "type": "string" }, "suggestions": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "suggestion": { "type": "string" }, "rank": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "relevance": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "highlighted": { "maxItems": 20, "type": "array", "items": { "type": "string" } } }, "required": [ "suggestion", "rank", "relevance", "type", "highlighted" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "keyword", "suggestions" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_google_business_questions", "title": "Get Google business questions", "description": "Fetches Google Business Profile questions and answers for one business keyword near a coordinate. Run this only when Q&A evidence is needed. Charges credits.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Business name or search phrase identifying the Google Business Profile." }, "near": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90, "description": "Latitude of the search center." }, "longitude": { "type": "number", "minimum": -180, "maximum": 180, "description": "Longitude of the search center." }, "radiusKm": { "type": "number", "minimum": 1, "maximum": 100000, "description": "Search radius around the center, in kilometers." } }, "required": [ "latitude", "longitude", "radiusKm" ], "description": "Coordinate and radius to search around." }, "depth": { "description": "Maximum Q&A rows to fetch (1-100). Defaults to 20.", "type": "integer", "minimum": 1, "maximum": 100 }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "keyword", "near" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "questions": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "questions" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_google_connections", "title": "Google connections and setup links", "description": "Read configured Search Console/Analytics status and browser setup URLs. Stored status is not a fresh access verification. Google consent/property selection must be completed by the user in the browser; no tokens returned. Free.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "project_id": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" }, "search_console": { "type": "object", "properties": { "configured": { "type": "boolean" }, "property": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "handoff_url": { "type": "string", "format": "uri" } }, "required": [ "configured", "property", "handoff_url" ], "additionalProperties": false }, "analytics": { "type": "object", "properties": { "configured": { "type": "boolean" }, "property": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "handoff_url": { "type": "string", "format": "uri" } }, "required": [ "configured", "property", "handoff_url" ], "additionalProperties": false }, "requires_browser_consent": { "type": "boolean", "const": true }, "access_verified": { "type": "boolean", "const": false } }, "required": [ "project_id", "search_console", "analytics", "requires_browser_consent", "access_verified" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_historical_serps", "title": "Get historical Google SERPs", "description": "Compare monthly Google search-result snapshots for one keyword across up to 12 months. Uses credits based on the requested date range.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keyword": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Keyword or query to research." }, "dateFrom": { "description": "Optional start date (YYYY-MM-DD), up to 12 calendar months.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "dateTo": { "description": "Optional end date (YYYY-MM-DD).", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "keyword" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "keyword": { "type": "string" }, "snapshots": { "maxItems": 12, "type": "array", "items": { "type": "object", "properties": { "checkedAt": { "type": "string" }, "totalResults": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "itemTypes": { "maxItems": 50, "type": "array", "items": { "type": "string" } }, "results": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "rank": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "rank", "title", "domain", "url", "description" ], "additionalProperties": false } } }, "required": [ "checkedAt", "totalResults", "itemTypes", "results" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "keyword", "snapshots" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_implementation_proposal", "title": "Read proposed website change", "description": "Read an Opportunity's saved proposal versions, approval and live-check evidence. Approval, customer-reported implementation and measured results are distinct. No paid calls.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "opportunityId": { "type": "string", "minLength": 1 } }, "required": [ "projectId", "opportunityId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_keyword_import", "title": "Read import results", "description": "Read per-row added, duplicate, skipped and invalid outcomes for an actor-owned saved import batch. No processing or paid research.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "batchId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "batchId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_keyword_import_context", "title": "Read saved import context", "description": "Read permitted paused tracking setups, project defaults and this actor's retained import batches. No paid research or historical metric recalculation.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_keyword_metrics", "title": "Get keyword metrics", "description": "Check up to 700 known keywords with volume, organic KD, intent, CPC and monthly trends. Returns one row per requested phrase; null means no estimate, not zero. Country-level data only. For supported primary-database markets, includes one batched volume fallback when needed, under a single capped credit hold. Other countries have no KD/intent. Cached results incur no new lookup charge. The result includes the maximum usage and hold; each row has check_status.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keywords": { "minItems": 1, "maxItems": 700, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 }, "description": "Keywords to fetch metrics for (1-700)." }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." }, "includeMonthlyTrends": { "description": "Include monthly search-volume trend rows. Defaults to true.", "type": "boolean" }, "includeClickstreamData": { "description": "Refine search volumes with clickstream data, which disaggregates Google Ads' grouped close-variant volumes (plurals/misspellings). DOUBLES the credit cost of the call. Default false. No effect for countries served from Google Ads data.", "type": "boolean" }, "sortBy": { "description": "Sort order for returned rows. Defaults to search_volume.", "type": "string", "enum": [ "search_volume", "keyword_difficulty", "cpc", "competition" ] } }, "required": [ "projectId", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "coverage": { "type": "object", "properties": { "status": { "type": "string", "const": "complete" }, "requested_phrases": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "checked_phrases": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "acquired_at": { "type": "string" }, "from_cache": { "type": "boolean" }, "maximum_usage_usd": { "type": "string" }, "temporary_hold_usd": { "type": "string" } }, "required": [ "status", "requested_phrases", "checked_phrases", "acquired_at", "from_cache", "maximum_usage_usd", "temporary_hold_usd" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "keywords", "coverage" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_keyword_trend_related", "title": "Get related Google Trends topics", "description": "Find top and rising Google Trends queries and topics for one keyword. Uses credits when called.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keyword": { "type": "string", "minLength": 2, "maxLength": 100, "description": "Seed keyword whose related trend queries and topics to fetch." }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "keyword" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "keyword": { "type": "string" }, "queries": { "type": "object", "properties": { "top": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "label", "value", "detail" ], "additionalProperties": false } }, "rising": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "label", "value", "detail" ], "additionalProperties": false } } }, "required": [ "top", "rising" ], "additionalProperties": false }, "topics": { "type": "object", "properties": { "top": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "label", "value", "detail" ], "additionalProperties": false } }, "rising": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "detail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "label", "value", "detail" ], "additionalProperties": false } } }, "required": [ "top", "rising" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "keyword", "queries", "topics" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_keyword_trends", "title": "Get keyword trends", "description": "Compare relative search popularity for one to five keywords over the last 12 months. Uses credits when called.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keywords": { "minItems": 1, "maxItems": 5, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 700 }, "description": "One to five keywords to compare." }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true } }, "required": [ "projectId", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "string" } }, "averages": { "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "points": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "keywords", "averages", "points" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_lighthouse_issues", "title": "Get Lighthouse issue details", "description": "Read stored Lighthouse scores, metrics, and actionable issue details for a resultId returned in get_audit_results data.lighthouse. No new performance run or usage charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "resultId": { "type": "string", "minLength": 1 } }, "required": [ "projectId", "resultId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_local_business_profile", "title": "Get local business profile", "description": "Returns a Google Business Profile snapshot with identity, location, categories, ratings, review topics, and claimed status. Uses one metered request.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "query": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Business name, Google CID, or Google place ID." }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "query" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "query": { "type": "string" }, "profile": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "fetchedAt": { "type": "string" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "query", "profile", "fetchedAt" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_local_research", "title": "Read a saved local job", "description": "Free saved grid/posts read. Includes measured not-found versus failed/unknown point states and successful-point denominators. Never posts or polls provider tasks.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "runId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_local_review_search", "title": "Get local review search", "description": "Collects a project-owned Google, Trustpilot, or Tripadvisor review task. Collection is free because the standard task was metered when created.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "platform": { "type": "string", "enum": [ "google", "trustpilot", "tripadvisor" ] }, "taskId": { "anyOf": [ { "type": "string", "pattern": "^job_[a-zA-Z0-9_-]{1,100}$" }, { "type": "string", "pattern": "^[\\da-f]{8}-(?:[\\da-f]{4}-){3}[\\da-f]{12}$" } ], "description": "FlexQueries job identifier returned when starting a search." } }, "required": [ "projectId", "platform", "taskId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "platform": { "type": "string" }, "taskId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "failed", "completed" ] }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "platform", "taskId", "status" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_local_serp_results", "title": "Get local SERP results", "description": "Fetches one Google Maps or Local Finder SERP near a coordinate. Set near.latitude and near.longitude, plus optional near.zoom (4-18; higher narrows the area). Zoom is not a distance radius; radiusKm is invalid for this tool. Omitted zoom uses 17 for Maps or 9 for Local Finder. Returns ranked business listings; match a target using its name, address or placeId. Charges credits.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keyword": { "type": "string", "minLength": 1, "maxLength": 120, "description": "Search query to run on Google Maps or Local Finder." }, "near": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90, "description": "Latitude of the search center." }, "longitude": { "type": "number", "minimum": -180, "maximum": 180, "description": "Longitude of the search center." }, "zoom": { "description": "Map zoom level (4-18), not a distance radius. Higher zoom narrows the local area. Omitted = 17 for Maps or 9 for Local Finder.", "type": "integer", "minimum": 4, "maximum": 18 } }, "required": [ "latitude", "longitude" ], "additionalProperties": false, "description": "Search center with optional map zoom; radius inputs are not supported for local SERPs." }, "searchType": { "description": "Which local SERP to fetch. Defaults to maps.", "type": "string", "enum": [ "maps", "local_finder" ] }, "device": { "description": "Device the SERP is rendered for. Defaults to desktop.", "type": "string", "enum": [ "desktop", "mobile" ] }, "depth": { "description": "Number of results to fetch (1-100). Defaults to 20.", "type": "integer", "minimum": 1, "maximum": 100 }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "keyword", "near" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "results" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_merchant_product_search", "title": "Get product search", "description": "Check a project-owned Google Shopping or Amazon product search and return its results when ready. Starting the search uses credits; checking progress does not use more credits.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "platform": { "type": "string", "enum": [ "google_shopping", "amazon" ] }, "taskId": { "anyOf": [ { "type": "string", "pattern": "^job_[a-zA-Z0-9_-]{1,100}$" }, { "type": "string", "pattern": "^[\\da-f]{8}-(?:[\\da-f]{4}-){3}[\\da-f]{12}$" } ], "description": "FlexQueries job identifier returned when starting a search." } }, "required": [ "projectId", "platform", "taskId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "platform": { "type": "string" }, "taskId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "failed", "completed" ] }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "platform", "taskId", "status" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_monitoring", "title": "Read schedules, history and spend forecast", "description": "Read existing project schedules, saved run links, pending holds and a conservative 30-day forecast. Forecast is a ceiling, not a guaranteed invoice. Financial scope depends on role; no schedules or paid refreshes are started.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_operation_recovery", "title": "Read saved failure and financial outcome", "description": "Read an authorized saved operation reference, safe recovery steps and confirmed financial outcome. Pending holds are not refunds; successful partial work may remain charged. Never starts retries, releases holds, changes credits or uploads diagnostics.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "reference": { "type": "string", "maxLength": 150, "pattern": "^(site_audit|rank_tracking|ai_visibility|opportunities|competitor_watch|reports|product_search|local_reviews|reservation):[a-zA-Z0-9_-]{1,100}$" } }, "required": [ "projectId", "reference" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_opportunities", "title": "Read saved SEO opportunities", "description": "Read bounded saved recommendations, evidence, current implementation progress and discovery sets for this project. Does not buy research. Missing evidence is unknown, not zero.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "tab": { "default": "next", "type": "string", "enum": [ "next", "measuring", "history" ] }, "kind": { "default": "all", "type": "string", "enum": [ "improve", "decline", "conversion", "content", "technical", "links", "mentions", "ai", "local", "all" ] }, "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 10000 }, "runId": { "type": "string", "minLength": 1, "maxLength": 100 }, "runPage": { "type": "integer", "minimum": 1, "maximum": 10000 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_opportunity_research", "title": "Read opportunity research progress", "description": "Read this project's saved research progress, completed/unavailable/skipped checks and actual settled charges. No paid refresh or replacement run.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "runId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_outcome_events", "title": "List observed outcome events", "description": "Owner/Admin only. Read up to 100 observed or configured GA4 events and website compatibility before selecting the project goal. No paid calls.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_outcome_settings", "title": "Read project business goal", "description": "Read the selected GA4 goal, observed/configured event selection and connected property identity. No paid calls.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_page_keyword_gap", "title": "Get exact-page keyword gap", "description": "Compare the organic keywords of two to 10 exact pages or folders. Uses credits based on the requested result limit.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "pages": { "minItems": 2, "maxItems": 10, "type": "array", "items": { "type": "string", "maxLength": 2048, "format": "uri" }, "description": "Two to 10 exact competitor page or folder URLs." }, "excludePages": { "default": [], "description": "Optional exact pages to exclude.", "maxItems": 5, "type": "array", "items": { "type": "string", "maxLength": 2048, "format": "uri" } }, "mode": { "default": "intersect", "type": "string", "enum": [ "intersect", "union" ] }, "limit": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "pages" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "totalCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "rows": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string" }, "searchVolume": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "cpc": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "competition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rankings": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "page": { "type": "string" }, "rank": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "page", "rank", "url" ], "additionalProperties": false } } }, "required": [ "keyword", "searchVolume", "cpc", "competition", "intent", "rankings" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "totalCount", "rows" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_page_plan", "title": "Read page targets and history", "description": "Read a project-owned page or unpublished plan, retained audit evidence, targets, briefs and linked Opportunities. No paid calls.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "pageId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "pageId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_pages", "title": "Read page plans", "description": "Read known project pages, intended targets, saved performance and work. Coverage can be capped; missing metrics mean unavailable, not zero. No paid research.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "search": { "default": "", "type": "string", "maxLength": 200 }, "filter": { "default": "actionable", "type": "string", "enum": [ "actionable", "all", "unassigned", "planned", "issues", "review" ] }, "page": { "default": 1, "type": "integer", "minimum": 1, "maximum": 1000 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_project_report", "title": "Get project report", "description": "Read the project report: latest audit and rank summaries, Search Console totals, GA4, branding, and generation time. Missing sections are null, not zero. No FlexQueries usage charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "customSections": { "type": "object", "properties": { "seriesId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "templateVersion": { "type": "string", "const": "safe-blocks-v1" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "sourceSnapshots": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "reportId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "title": { "type": "string" }, "capturedAt": { "type": "string" }, "generatedAt": { "type": "string" } }, "required": [ "reportId", "title", "capturedAt", "generatedAt" ], "additionalProperties": false } }, "generationCostCredits": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "blocks": { "minItems": 1, "maxItems": 40, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "heading" }, "text": { "type": "string", "minLength": 1, "maxLength": 160 }, "level": { "default": 2, "anyOf": [ { "type": "number", "const": 2 }, { "type": "number", "const": 3 } ] } }, "required": [ "type", "text", "level" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "paragraph" }, "text": { "type": "string", "minLength": 1, "maxLength": 4000 } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "list" }, "items": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 1000 } } }, "required": [ "type", "items" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "table" }, "title": { "type": "string", "minLength": 1, "maxLength": 160 }, "headers": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "string", "const": "" } ] } }, "rows": { "maxItems": 100, "type": "array", "items": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "string", "const": "" } ] } } } }, "required": [ "type", "title", "headers", "rows" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "citation" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "type", "label", "url" ], "additionalProperties": false } ] } }, "note": { "type": "string" } }, "required": [ "seriesId", "templateVersion", "revision", "sourceSnapshots", "generationCostCredits", "blocks", "note" ], "additionalProperties": false }, "generatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "settings": { "type": "object", "properties": { "reportBrandName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accentColor": { "type": "string" }, "footerText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "weeklyDigestEnabled": { "type": "boolean" } }, "required": [ "reportBrandName", "accentColor", "footerText", "weeklyDigestEnabled" ], "additionalProperties": false }, "audit": { "anyOf": [ { "type": "object", "properties": { "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pagesCrawled": { "type": "number" }, "issues": { "type": "object", "properties": { "critical": { "type": "number" }, "warning": { "type": "number" }, "info": { "type": "number" } }, "required": [ "critical", "warning", "info" ], "additionalProperties": false } }, "required": [ "completedAt", "pagesCrawled", "issues" ], "additionalProperties": false }, { "type": "null" } ] }, "ranks": { "anyOf": [ { "type": "object", "properties": { "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tracked": { "type": "number" }, "ranking": { "type": "number" }, "top10": { "type": "number" }, "averagePosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "completedAt", "tracked", "ranking", "top10", "averagePosition" ], "additionalProperties": false }, { "type": "null" } ] }, "gsc": { "anyOf": [ { "type": "object", "properties": { "clicks": { "type": "number" }, "impressions": { "type": "number" } }, "required": [ "clicks", "impressions" ], "additionalProperties": false }, { "type": "null" } ] }, "ga4": { "anyOf": [ { "type": "object", "properties": { "period": { "type": "object", "properties": { "startDate": { "type": "string" }, "endDate": { "type": "string" }, "previousStartDate": { "type": "string" }, "previousEndDate": { "type": "string" } }, "required": [ "startDate", "endDate", "previousStartDate", "previousEndDate" ], "additionalProperties": false }, "totals": { "type": "object", "properties": { "activeUsers": { "type": "number" }, "sessions": { "type": "number" }, "pageViews": { "type": "number" }, "events": { "type": "number" }, "keyEvents": { "type": "number" } }, "required": [ "activeUsers", "sessions", "pageViews", "events", "keyEvents" ], "additionalProperties": false }, "previousTotals": { "type": "object", "properties": { "activeUsers": { "type": "number" }, "sessions": { "type": "number" }, "pageViews": { "type": "number" }, "events": { "type": "number" }, "keyEvents": { "type": "number" } }, "required": [ "activeUsers", "sessions", "pageViews", "events", "keyEvents" ], "additionalProperties": false }, "landingPages": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "sessions": { "type": "number" }, "activeUsers": { "type": "number" }, "keyEvents": { "type": "number" } }, "required": [ "path", "sessions", "activeUsers", "keyEvents" ], "additionalProperties": false } } }, "required": [ "period", "totals", "previousTotals", "landingPages" ], "additionalProperties": false }, { "type": "null" } ] }, "outcomes": { "anyOf": [ { "type": "object", "properties": { "observedAt": { "type": "string" }, "propertyId": { "type": "string" }, "host": { "type": "string" }, "view": { "type": "string", "enum": [ "organic", "ai_referrals" ] }, "source": { "type": "string" }, "classifierVersion": { "type": "string" }, "period": { "type": "object", "properties": { "startDate": { "type": "string" }, "endDate": { "type": "string" }, "previousStartDate": { "type": "string" }, "previousEndDate": { "type": "string" } }, "required": [ "startDate", "endDate", "previousStartDate", "previousEndDate" ], "additionalProperties": false }, "goal": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "number" } }, "required": [ "label", "events", "revision" ], "additionalProperties": false }, { "type": "null" } ] }, "current": { "type": "object", "properties": { "sessions": { "type": "number", "minimum": 0 }, "selectedEvents": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rows": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "source": { "type": "string" }, "sessions": { "type": "number", "minimum": 0 }, "selectedEvents": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "path", "source", "sessions", "selectedEvents", "purchaseRevenue" ], "additionalProperties": false } }, "capped": { "type": "boolean" }, "timeZone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thresholded": { "type": "boolean" } }, "required": [ "sessions", "selectedEvents", "purchaseRevenue", "currency", "rows", "capped", "timeZone", "thresholded" ], "additionalProperties": false }, "previous": { "type": "object", "properties": { "sessions": { "type": "number", "minimum": 0 }, "selectedEvents": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rows": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "source": { "type": "string" }, "sessions": { "type": "number", "minimum": 0 }, "selectedEvents": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "path", "source", "sessions", "selectedEvents", "purchaseRevenue" ], "additionalProperties": false } }, "capped": { "type": "boolean" }, "timeZone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thresholded": { "type": "boolean" } }, "required": [ "sessions", "selectedEvents", "purchaseRevenue", "currency", "rows", "capped", "timeZone", "thresholded" ], "additionalProperties": false }, "eventError": { "type": "boolean" }, "revenueError": { "type": "boolean" } }, "required": [ "observedAt", "propertyId", "host", "view", "source", "classifierVersion", "period", "goal", "current", "previous", "eventError", "revenueError" ], "additionalProperties": false }, { "type": "null" } ] }, "work": { "anyOf": [ { "type": "object", "properties": { "observedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "capped": { "type": "boolean" }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "opportunityId": { "type": "string" }, "title": { "type": "string" }, "pageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "observedAt": { "type": "string" }, "implementedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "proposalId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "approvedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verification": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "opportunityId", "title", "pageUrl", "status", "observedAt", "implementedAt", "reviewAt", "proposalId", "kind", "approvedAt", "verification", "verifiedAt" ], "additionalProperties": false } } }, "required": [ "observedAt", "capped", "items" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "generatedAt", "settings", "audit", "ranks", "gsc", "ga4" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_prompt_monitor_aliases", "title": "Read confirmed brand aliases", "description": "Read the names explicitly confirmed for future prompt checks. Free; saved runs use frozen names, not today's settings.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "configId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_prompt_monitor_answer", "title": "Read saved prompt answer", "description": "Read a single saved consumer-search answer and its citations. Free saved read; does not refresh search.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "observationId": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "projectId", "configId", "observationId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_prompt_monitor_history", "title": "Read prompt monitor history", "description": "Read up to 20 saved runs with coverage, mention and citation metadata. Missing checks are not absent-brand results. Free; use get_prompt_monitor_answer for full answer text.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "configId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_prompt_monitor_sources", "title": "Read AI citation sources", "description": "Aggregate all saved citations in one run by page/domain, then paginate. Filter own/competitor/third-party, engine/topic or competitor gaps. Native references link to saved answers. Free; never crawls a source or collects a new answer.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "grouping": { "default": "pages", "type": "string", "enum": [ "pages", "domains" ] }, "ownership": { "default": "all", "type": "string", "enum": [ "all", "own", "competitor", "third_party" ] }, "engine": { "type": "string", "enum": [ "chatgpt", "gemini", "google_overview", "google_ai_mode", "claude", "perplexity" ] }, "topic": { "type": "string", "maxLength": 100 }, "competitorGap": { "default": false, "type": "boolean" }, "relation": { "default": "citations", "type": "string", "enum": [ "citations", "relied_on_source", "retrieved_result", "all" ] }, "limit": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "maxLength": 2000 } }, "required": [ "projectId", "configId", "runId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_prompt_monitor_trends", "title": "Compare exact-prompt trends", "description": "Free saved analysis. Compare equal-weight matched prompt/engine/market/model/matching cells over adjacent periods. Separate written brand mentions and citations. Change claims require at least 90% valid-answer coverage in both periods; missing/untriggered results are not zero mentions.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "days": { "default": 28, "anyOf": [ { "type": "number", "const": 7 }, { "type": "number", "const": 28 }, { "type": "number", "const": 90 } ] }, "cohort": { "default": "neutral", "type": "string", "enum": [ "neutral", "branded", "all" ] }, "engine": { "type": "string", "enum": [ "chatgpt", "gemini", "google_overview", "google_ai_mode", "claude", "perplexity" ] }, "topic": { "type": "string", "maxLength": 100 } }, "required": [ "projectId", "configId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_prompt_source_snapshot", "title": "Read a retained cited page", "description": "Free owned saved snapshot, text and historical interpretations. Supply runId for that run's frozen finding context; default is the latest authorized use. Interpretations retain their original observation/brand set. Never refetches or calls a model.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "snapshotId": { "type": "string", "minLength": 1, "maxLength": 200 }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "configId", "snapshotId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_rank_history", "title": "Get rank history and insights", "description": "Read position history for one trackingKeywordId, or 90-day tracker insights when it is omitted. sinceDays applies to keyword history. Missing ranks stay null. No provider charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "trackingKeywordId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "sinceDays": { "default": 365, "type": "integer", "exclusiveMinimum": 0, "maximum": 730 } }, "required": [ "projectId", "configId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_rank_tracker", "title": "Get rank tracker", "description": "Read rank tracker configs, latest run status, and keyword positions. With trackerId, returns config, latestRun and results. Without it, lists trackers. Uses no credits. Use run_rank_check to start a paid check. latestRun describes the newest job; results can still contain the previous completed snapshot while it runs.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "comparePeriod": { "description": "Compare saved positions with 1d, 7d, 30d, or 90d ago.", "type": "string", "enum": [ "1d", "7d", "30d", "90d" ] }, "trackerId": { "description": "Rank tracker config ID. If omitted, lists all rank trackers in the project.", "type": "string" } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "configs": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "results": { "type": "object", "properties": {}, "additionalProperties": {} }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_ranked_keywords", "title": "Get ranked keywords", "description": "Returns exact keyword, URL, rank, search volume, CPC, intent, and traffic rows for a domain or page. Use this for strategy evidence; use get_domain_overview for aggregate domain footprint. Charges credits.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "target": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Domain (no protocol/www) or absolute page URL to list ranked keywords for." }, "market": { "description": "Optional market object. Omitted = the project's default market (United States unless the project overrides it).", "type": "object", "properties": { "country": { "description": "ISO country selector, such as US, GB or DE. US name aliases remain supported.", "anyOf": [ { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, { "type": "string", "enum": [ "USA", "United States", "United States of America" ] } ] } } }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." }, "resultTypes": { "description": "SERP result types to include. Defaults to organic and paid.", "minItems": 1, "maxItems": 5, "type": "array", "items": { "type": "string", "enum": [ "organic", "paid", "featured_snippet", "local_pack", "ai_overview_reference" ] } }, "includeSubdomains": { "description": "Include subdomains of the target. Defaults to true for domains, false for page URLs.", "type": "boolean" }, "minSearchVolume": { "description": "Only return keywords with at least this monthly search volume.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxRank": { "description": "Only return keywords ranking at this position or better.", "type": "integer", "minimum": 1, "maximum": 100 }, "excludeBrandTerms": { "description": "Exclude keywords containing any of these brand terms.", "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "sortBy": { "description": "Sort order for returned rows. Defaults to search_volume.", "type": "string", "enum": [ "rank", "search_volume", "traffic_estimate", "cpc" ] }, "limit": { "description": "Maximum rows to return (1-100). Defaults to 50.", "type": "integer", "minimum": 1, "maximum": 100 }, "offset": { "description": "Rows to skip for pagination.", "type": "integer", "minimum": 0, "maximum": 1000 } }, "required": [ "projectId", "target" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "totalCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "keywords", "totalCount" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_report_delivery", "title": "Read report delivery", "description": "Read saved free report delivery settings and history. Only project managers receive recipient addresses and delivery-message details. No refresh, email or charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_saved_report", "title": "Read saved report", "description": "Read an existing report snapshot without refreshing data or charging credits.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "reportId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "reportId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "createdAt": { "type": "string" }, "report": { "anyOf": [ { "type": "object", "properties": { "customSections": { "type": "object", "properties": { "seriesId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "templateVersion": { "type": "string", "const": "safe-blocks-v1" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "sourceSnapshots": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "reportId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "title": { "type": "string" }, "capturedAt": { "type": "string" }, "generatedAt": { "type": "string" } }, "required": [ "reportId", "title", "capturedAt", "generatedAt" ], "additionalProperties": false } }, "generationCostCredits": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "blocks": { "minItems": 1, "maxItems": 40, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "heading" }, "text": { "type": "string", "minLength": 1, "maxLength": 160 }, "level": { "default": 2, "anyOf": [ { "type": "number", "const": 2 }, { "type": "number", "const": 3 } ] } }, "required": [ "type", "text", "level" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "paragraph" }, "text": { "type": "string", "minLength": 1, "maxLength": 4000 } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "list" }, "items": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 1000 } } }, "required": [ "type", "items" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "table" }, "title": { "type": "string", "minLength": 1, "maxLength": 160 }, "headers": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "string", "const": "" } ] } }, "rows": { "maxItems": 100, "type": "array", "items": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "string", "const": "" } ] } } } }, "required": [ "type", "title", "headers", "rows" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "citation" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "type", "label", "url" ], "additionalProperties": false } ] } }, "note": { "type": "string" } }, "required": [ "seriesId", "templateVersion", "revision", "sourceSnapshots", "generationCostCredits", "blocks", "note" ], "additionalProperties": false }, "generatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "settings": { "type": "object", "properties": { "reportBrandName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accentColor": { "type": "string" }, "footerText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "weeklyDigestEnabled": { "type": "boolean" } }, "required": [ "reportBrandName", "accentColor", "footerText", "weeklyDigestEnabled" ], "additionalProperties": false }, "audit": { "anyOf": [ { "type": "object", "properties": { "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pagesCrawled": { "type": "number" }, "issues": { "type": "object", "properties": { "critical": { "type": "number" }, "warning": { "type": "number" }, "info": { "type": "number" } }, "required": [ "critical", "warning", "info" ], "additionalProperties": false } }, "required": [ "completedAt", "pagesCrawled", "issues" ], "additionalProperties": false }, { "type": "null" } ] }, "ranks": { "anyOf": [ { "type": "object", "properties": { "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tracked": { "type": "number" }, "ranking": { "type": "number" }, "top10": { "type": "number" }, "averagePosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "completedAt", "tracked", "ranking", "top10", "averagePosition" ], "additionalProperties": false }, { "type": "null" } ] }, "gsc": { "anyOf": [ { "type": "object", "properties": { "clicks": { "type": "number" }, "impressions": { "type": "number" } }, "required": [ "clicks", "impressions" ], "additionalProperties": false }, { "type": "null" } ] }, "ga4": { "anyOf": [ { "type": "object", "properties": { "period": { "type": "object", "properties": { "startDate": { "type": "string" }, "endDate": { "type": "string" }, "previousStartDate": { "type": "string" }, "previousEndDate": { "type": "string" } }, "required": [ "startDate", "endDate", "previousStartDate", "previousEndDate" ], "additionalProperties": false }, "totals": { "type": "object", "properties": { "activeUsers": { "type": "number" }, "sessions": { "type": "number" }, "pageViews": { "type": "number" }, "events": { "type": "number" }, "keyEvents": { "type": "number" } }, "required": [ "activeUsers", "sessions", "pageViews", "events", "keyEvents" ], "additionalProperties": false }, "previousTotals": { "type": "object", "properties": { "activeUsers": { "type": "number" }, "sessions": { "type": "number" }, "pageViews": { "type": "number" }, "events": { "type": "number" }, "keyEvents": { "type": "number" } }, "required": [ "activeUsers", "sessions", "pageViews", "events", "keyEvents" ], "additionalProperties": false }, "landingPages": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "sessions": { "type": "number" }, "activeUsers": { "type": "number" }, "keyEvents": { "type": "number" } }, "required": [ "path", "sessions", "activeUsers", "keyEvents" ], "additionalProperties": false } } }, "required": [ "period", "totals", "previousTotals", "landingPages" ], "additionalProperties": false }, { "type": "null" } ] }, "outcomes": { "anyOf": [ { "type": "object", "properties": { "observedAt": { "type": "string" }, "propertyId": { "type": "string" }, "host": { "type": "string" }, "view": { "type": "string", "enum": [ "organic", "ai_referrals" ] }, "source": { "type": "string" }, "classifierVersion": { "type": "string" }, "period": { "type": "object", "properties": { "startDate": { "type": "string" }, "endDate": { "type": "string" }, "previousStartDate": { "type": "string" }, "previousEndDate": { "type": "string" } }, "required": [ "startDate", "endDate", "previousStartDate", "previousEndDate" ], "additionalProperties": false }, "goal": { "anyOf": [ { "type": "object", "properties": { "label": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "number" } }, "required": [ "label", "events", "revision" ], "additionalProperties": false }, { "type": "null" } ] }, "current": { "type": "object", "properties": { "sessions": { "type": "number", "minimum": 0 }, "selectedEvents": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rows": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "source": { "type": "string" }, "sessions": { "type": "number", "minimum": 0 }, "selectedEvents": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "path", "source", "sessions", "selectedEvents", "purchaseRevenue" ], "additionalProperties": false } }, "capped": { "type": "boolean" }, "timeZone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thresholded": { "type": "boolean" } }, "required": [ "sessions", "selectedEvents", "purchaseRevenue", "currency", "rows", "capped", "timeZone", "thresholded" ], "additionalProperties": false }, "previous": { "type": "object", "properties": { "sessions": { "type": "number", "minimum": 0 }, "selectedEvents": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rows": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "source": { "type": "string" }, "sessions": { "type": "number", "minimum": 0 }, "selectedEvents": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "purchaseRevenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "path", "source", "sessions", "selectedEvents", "purchaseRevenue" ], "additionalProperties": false } }, "capped": { "type": "boolean" }, "timeZone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thresholded": { "type": "boolean" } }, "required": [ "sessions", "selectedEvents", "purchaseRevenue", "currency", "rows", "capped", "timeZone", "thresholded" ], "additionalProperties": false }, "eventError": { "type": "boolean" }, "revenueError": { "type": "boolean" } }, "required": [ "observedAt", "propertyId", "host", "view", "source", "classifierVersion", "period", "goal", "current", "previous", "eventError", "revenueError" ], "additionalProperties": false }, { "type": "null" } ] }, "work": { "anyOf": [ { "type": "object", "properties": { "observedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "capped": { "type": "boolean" }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "opportunityId": { "type": "string" }, "title": { "type": "string" }, "pageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "observedAt": { "type": "string" }, "implementedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "proposalId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "kind": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "approvedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verification": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "opportunityId", "title", "pageUrl", "status", "observedAt", "implementedAt", "reviewAt", "proposalId", "kind", "approvedAt", "verification", "verifiedAt" ], "additionalProperties": false } } }, "required": [ "observedAt", "capped", "items" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "generatedAt", "settings", "audit", "ranks", "gsc", "ga4" ], "additionalProperties": false }, { "type": "null" } ] }, "generationUsage": { "anyOf": [ { "type": "object", "properties": { "settledModelCreditUsd": { "type": "number", "minimum": 0 }, "status": { "type": "string", "enum": [ "final", "partial" ] }, "scope": { "type": "string", "const": "associated_chat_turn_model_and_summary" }, "checkedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "note": { "type": "string" } }, "required": [ "settledModelCreditUsd", "status", "scope", "checkedAt", "note" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "title", "createdAt", "report" ], "additionalProperties": false }, { "type": "null" } ] }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_search_console_performance", "title": "Get Google Search Console performance", "description": "Query the connected Search Console property's Search Analytics: clicks, impressions, CTR, and average position by query/page/country/device/date. First-party data — use it for what already ranks, near-ranking queries, and pages with real demand. ctr is a 0-1 fraction; position is a 1-based average; dates are Pacific Time; the last ~3 days may be incomplete. Read-only; uses no credits.", "inputSchema": { "type": "object", "properties": { "minImpressions": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "minPosition": { "type": "number", "minimum": 1, "maximum": 1000 }, "maxPosition": { "type": "number", "minimum": 1, "maximum": 1000 }, "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "dimensions": { "description": "Group rows by these dimensions. Default ['query']. Use ['page'] for top pages, ['query','page'] to map queries to pages / spot cannibalization, ['date'] for a time series.", "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "query", "page", "country", "device", "date", "searchAppearance" ] } }, "dateRange": { "description": "Convenience window (default last_28_days). End is set ~3 days back for GSC data lag. Ignored if startDate+endDate are given. Max lookback is 16 months.", "type": "string", "enum": [ "last_7_days", "last_28_days", "last_3_months", "last_6_months", "last_12_months", "last_16_months" ] }, "startDate": { "description": "Explicit start (YYYY-MM-DD, Pacific Time). Use with endDate.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endDate": { "description": "Explicit end (YYYY-MM-DD, Pacific Time). Use with startDate.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "filters": { "description": "AND-combined filters. To get the queries for one page: [{dimension:'page',operator:'equals',expression:'https://example.com/post'}] with dimensions ['query'].", "maxItems": 5, "type": "array", "items": { "type": "object", "properties": { "dimension": { "type": "string", "enum": [ "query", "page", "country", "device", "date", "searchAppearance" ] }, "operator": { "default": "equals", "type": "string", "enum": [ "equals", "notEquals", "contains", "notContains" ] }, "expression": { "type": "string", "minLength": 1 } }, "required": [ "dimension", "expression" ] } }, "rowLimit": { "description": "Fetched rows per call (default/max 1000). Optional metric criteria filter this window, not the entire property. Paginate even if the window has no matches.", "type": "integer", "minimum": 1, "maximum": 1000 }, "startRow": { "description": "Google row-space pagination offset (max 10000).", "type": "integer", "minimum": 0, "maximum": 10000 }, "type": { "description": "Search type (default web).", "type": "string", "enum": [ "web", "image", "video", "news", "googleNews", "discover" ] }, "dataState": { "description": "'all' (default) includes fresh/incomplete recent data.", "type": "string", "enum": [ "all", "final" ] } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "reason": { "type": "string" }, "connectUrl": { "type": "string" }, "setupDocsUrl": { "type": "string" }, "siteUrl": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "dimensions": { "type": "array", "items": { "type": "string" } }, "rowCount": { "type": "number" }, "fetchedRowCount": { "type": "number" }, "scannedStartRow": { "type": "number" }, "metricFilters": { "type": "object", "properties": { "minImpressions": { "type": "number", "minimum": 0, "maximum": 1000000000000 }, "minPosition": { "type": "number", "minimum": 1, "maximum": 1000 }, "maxPosition": { "type": "number", "minimum": 1, "maximum": 1000 } }, "additionalProperties": false }, "rows": { "type": "array", "items": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "string" } }, "clicks": { "type": "number" }, "impressions": { "type": "number" }, "ctr": { "type": "number" }, "position": { "type": "number" } }, "required": [ "clicks", "impressions", "ctr", "position" ], "additionalProperties": {} } }, "hasMore": { "type": "boolean" }, "nextStartRow": { "type": "number" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "ok" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_serp_intelligence", "title": "Get SERP intelligence", "description": "Analyze up to 25 keywords with the dashboard’s SERP intelligence metrics. Paid research in the project market unless explicitly overridden.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "keywords": { "minItems": 1, "maxItems": 25, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 700 } }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_serp_onpage_gaps", "title": "Get SERP on-page gaps", "description": "Inspect on-page coverage gaps for a keyword’s search results. Paid research, using the project market by default.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 700 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "keyword" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_serp_results", "title": "Get Google SERP results", "description": "Fetch live Google organic search results for 1-10 keywords, defaulting to depth 20. Depth 100 costs more and must be chosen explicitly. Hosted mode deducts the action price from the account balance. A per-keyword error does not fail the batch.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "depth": { "description": "Results to request per keyword. Defaults to 20; 100 is a separately priced deeper provider request.", "anyOf": [ { "type": "number", "const": 20 }, { "type": "number", "const": 100 } ] }, "queries": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "keyword": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Search query to fetch the SERP for." }, "device": { "type": "string", "enum": [ "desktop", "mobile" ] }, "locationName": { "description": "A supported city name from local-location discovery. Must belong to the selected country.", "type": "string", "minLength": 2, "maxLength": 250 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "keyword" ] }, "description": "1-10 queries. Bulk-friendly — prefer this over multiple single-query calls." } }, "required": [ "projectId", "queries" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "results": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "keyword": { "type": "string" }, "ok": { "type": "boolean", "const": true }, "items": { "type": "array", "items": { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "absoluteRank": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "rank", "title", "url", "domain", "description" ], "additionalProperties": {} } } }, "required": [ "keyword", "ok", "items" ], "additionalProperties": {} }, { "type": "object", "properties": { "keyword": { "type": "string" }, "ok": { "type": "boolean", "const": false }, "error": { "type": "string" } }, "required": [ "keyword", "ok", "error" ], "additionalProperties": {} } ] } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "results" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_serp_screenshot", "title": "Get SERP screenshot", "description": "Request the search-result screenshot available in SERP Intelligence. Returns the provider asset result; paid research in the project market.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 700 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "keyword" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_vertical_search", "title": "Get vertical search results", "description": "Returns bounded Bing, Google News, Google Images, Google Events, Google Dataset Search, or YouTube keyword intelligence. One metered request.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "engine": { "type": "string", "enum": [ "bing", "google_news", "google_images", "google_events", "google_datasets", "youtube_video" ], "description": "Search surface, including keyword-level YouTube results." }, "query": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Search query for the selected surface." }, "limit": { "default": 10, "type": "integer", "minimum": 1, "maximum": 20 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "engine", "query" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "engine": { "type": "string" }, "query": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "fetchedAt": { "type": "string" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "engine", "query", "items", "fetchedAt" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "get_web_mentions", "title": "Get web mentions", "description": "Returns bounded web citations, sentiment, content-rating distribution, publishing domains, and a 12-month trend for a brand or phrase. Uses five metered requests.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "query": { "type": "string", "minLength": 1, "maxLength": 250, "description": "Brand name, product, phrase, or domain to monitor." } }, "required": [ "projectId", "query" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "query": { "type": "string" }, "totalCount": { "type": "number" }, "rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sentiment": { "type": "object", "properties": {}, "additionalProperties": {} }, "topDomains": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "mentions": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "trends": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "ratingDistribution": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "query", "totalCount", "rank", "sentiment", "topDomains", "mentions", "trends", "ratingDistribution" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "inspect_urls", "title": "Inspect URLs in Google Search Console", "description": "Run Google Search Console's URL Inspection on up to 10 URLs of the connected property: index/coverage state, last crawl time, Google-selected vs declared canonical, and mobile/rich-results verdicts. Use it to answer 'is this page indexed? why not?'. Per-URL failures are reported inline. Read-only; uses no credits.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "urls": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "string", "format": "uri" }, "description": "1–10 absolute URLs to inspect. Each must belong to the connected property." }, "languageCode": { "description": "BCP-47 language for the inspection result (e.g. 'en-US').", "type": "string" } }, "required": [ "projectId", "urls" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "reason": { "type": "string" }, "connectUrl": { "type": "string" }, "setupDocsUrl": { "type": "string" }, "siteUrl": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "result": { "anyOf": [ {}, { "type": "null" } ] }, "error": { "type": "string" } }, "required": [ "url" ], "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "ok" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "link_page_work", "title": "Link page work", "description": "Link an existing project Opportunity or saved Content Studio brief to a page. Work status remains authoritative in its original feature; this does not create a new paid brief.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "pageId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": [ "brief", "opportunity" ] }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "pageId", "kind", "id" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "list_archived_projects", "title": "List archived projects", "description": "List archived workspace projects. Requires all-project management permission. No charge.", "inputSchema": { "type": "object", "properties": {}, "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "outputSchema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" }, "name": { "type": "string" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language_code": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "domain", "country_code", "country", "language_code", "created_at" ], "additionalProperties": false } } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "list_audit_schedules", "title": "List audit schedules", "description": "Read this project’s scheduled audits and active state. No provider charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "list_business_categories", "title": "Find business categories", "description": "Free cached public category catalogue with plain labels and stable internal slugs. No research purchase, profile edits or automatic category selection.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "query": { "default": "", "type": "string", "maxLength": 100 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "list_local_research", "title": "List saved local history", "description": "Free private saved grids or Business Profile posts. Bounded 30-result history pages; no refresh acquisition.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "kind": { "type": "string", "enum": [ "grid", "posts" ] }, "offset": { "default": 0, "type": "integer", "minimum": 0, "maximum": 500 } }, "required": [ "projectId", "kind" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "list_projects", "title": "List projects", "description": "Lists projects without using credits. Returns id, name, domain, countryCode, country and languageCode. Pass id as projectId. Tools use the project market when country/language are omitted. Numeric locationCode is a deprecated compatibility field.", "inputSchema": { "type": "object", "properties": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locationCode": { "type": "number" }, "countryCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "languageCode": { "type": "string" }, "url": { "type": "string" } }, "required": [ "id", "name", "locationCode", "countryCode", "country", "languageCode", "url" ], "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "projects" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "list_prompt_monitors", "title": "List prompt monitors", "description": "Read exact-prompt consumer-search tracking configurations, inventories and latest run coverage. Free saved read.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "list_prompt_source_snapshots", "title": "List retained cited pages", "description": "Read up to 20 saved snapshot metadata rows used in one owned run. Free, no source fetch or analysis.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "cursor": { "type": "string", "maxLength": 2000 } }, "required": [ "projectId", "configId", "runId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "list_saved_keywords", "title": "List saved keywords", "description": "Lists keywords saved to a project (with stored metrics like search volume, difficulty, CPC, and tags if available). Uses no credits — reads from FlexQueries's database, no paid research request. Use tag filters when the user asks for a saved segment; multiple tags match ANY tag.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "page": { "description": "Page number (default 1). Continue with nextPage while hasMore is true.", "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "search": { "description": "Optional keyword text filter.", "type": "string", "minLength": 1, "maxLength": 200 }, "tags": { "description": "Optional tag-name filters. Multiple tags match ANY tag.", "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "limit": { "description": "Maximum rows to return. Defaults to 100.", "anyOf": [ { "type": "number", "const": 50 }, { "type": "number", "const": 100 }, { "type": "number", "const": 250 } ] } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "totalCount": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "hasMore": { "type": "boolean" }, "nextPage": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "rows", "totalCount", "page", "pageSize", "hasMore", "nextPage", "tags" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "list_saved_report_shares", "title": "List public report links", "description": "List expiry and revocation metadata for a saved report's public links. Existing bearer URLs cannot be retrieved. No usage charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "reportId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "reportId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "type": "string" }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "createdAt", "expiresAt", "revokedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "list_saved_reports", "title": "List saved reports", "description": "List saved, immutable report snapshots for this project. No usage charge; does not refresh research.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "createdAt": { "type": "string" }, "projectId": { "type": "string" }, "templateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "title", "createdAt", "projectId", "templateId" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "list_site_audits", "title": "List site audits", "description": "List saved audits for this project, including IDs and status. Use an auditId with get_audit_status, get_audit_results, get_audit_issues or get_audit_pages. No provider charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "lookup_brand", "title": "Compare AI brand visibility", "description": "Look up brand/domain visibility and compare up to five competitors across supported AI-search platforms. Returns source metrics and share of voice. Paid research uses the account balance. Defaults to the project market.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "query": { "type": "string", "minLength": 1, "maxLength": 250 }, "competitors": { "default": [], "maxItems": 5, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 250 } }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "query" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "pin_rank_tracking_keywords", "title": "Pin rank tracking keywords", "description": "Pin or unpin selected saved keyword IDs in this project tracker for everyone with access. No research or credit charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keywordIds": { "minItems": 1, "maxItems": 2000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "pinned": { "type": "boolean" } }, "required": [ "projectId", "configId", "keywordIds", "pinned" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "preview_keyword_import", "title": "Preview mapped CSV import", "description": "Validate up to 2 MiB/2,000 CSV rows and column mapping without saving or spending. Rejects malformed records, flags duplicates and caps, preserves market/device/tag/URL scope. Requires project Editor access.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "csv": { "type": "string", "minLength": 1, "maxLength": 2097152 }, "mapping": { "type": "object", "properties": { "keyword": { "type": "integer", "minimum": 0, "maximum": 31 }, "location": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 31 }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 31 }, { "type": "null" } ] }, "tags": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 31 }, { "type": "null" } ] }, "target": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 31 }, { "type": "null" } ] }, "device": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 31 }, { "type": "null" } ] } }, "required": [ "keyword", "location", "language", "tags", "target", "device" ] }, "destination": { "type": "string", "enum": [ "saved", "tracking" ] }, "configId": { "default": null, "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "defaults": { "type": "object", "properties": { "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 1, "maxLength": 10 }, "devices": { "default": "both", "type": "string", "enum": [ "desktop", "mobile", "both" ] } }, "required": [ "locationCode", "languageCode" ] } }, "required": [ "projectId", "csv", "mapping", "destination", "defaults" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "query_analytics", "title": "Query Google Analytics", "description": "Read a bounded GA4 report from this project's connected Google property. Specify calendar dates (at most 366 days), allowed metrics/dimensions, limit <=500 and offset <=10000. Missing cells remain null; monetary values use the returned currency. Fresh Google access is checked. Free, subject to integration quotas.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "start_date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "end_date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "metrics": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "string", "enum": [ "activeUsers", "sessions", "screenPageViews", "eventCount", "keyEvents", "purchaseRevenue", "itemRevenue", "itemsPurchased", "totalPurchasers", "newUsers" ] } }, "dimensions": { "default": [ "date" ], "maxItems": 3, "type": "array", "items": { "type": "string", "enum": [ "date", "landingPagePlusQueryString", "sessionDefaultChannelGroup", "sessionSourceMedium", "eventName", "country", "sessionCampaignName", "itemName", "searchTerm", "deviceCategory", "newVsReturning" ] } }, "limit": { "default": 100, "type": "integer", "minimum": 1, "maximum": 500 }, "offset": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } }, "required": [ "start_date", "end_date", "metrics", "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "period": { "type": "object", "properties": { "start_date": { "type": "string" }, "end_date": { "type": "string" } }, "required": [ "start_date", "end_date" ], "additionalProperties": false }, "dimensions": { "type": "array", "items": { "type": "string" } }, "metrics": { "type": "array", "items": { "type": "string" } }, "rows": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "dimensions": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "metrics": { "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "required": [ "dimensions", "metrics" ], "additionalProperties": false } }, "row_count": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "next_offset": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "metadata": { "type": "object", "properties": { "currency_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "time_zone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thresholded": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "data_loss": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "empty_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sampling": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "samples_read": { "type": "string" }, "sampling_space": { "type": "string" } }, "required": [ "samples_read", "sampling_space" ], "additionalProperties": false } }, { "type": "null" } ] } }, "required": [ "currency_code", "time_zone", "thresholded", "data_loss" ], "additionalProperties": false } }, "required": [ "period", "dimensions", "metrics", "rows", "row_count", "next_offset", "metadata" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "quote_competitor_watch", "title": "Quote competitor monitoring", "description": "Get a complete quote for up to three rivals and bounded rank, page, link, content and optional US/English AI modules. Get explicit user consent to the scope, cadence and cap before creating or running monitoring.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "scope": { "type": "object", "properties": { "domain": { "type": "string", "minLength": 1, "maxLength": 253 }, "rivals": { "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 } }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "rankings": { "default": true, "type": "boolean" }, "links": { "default": false, "type": "boolean" }, "content": { "default": false, "type": "boolean" }, "ai": { "default": false, "type": "boolean" }, "aiHistory": { "default": false, "type": "boolean" } }, "required": [ "domain", "rivals", "locationCode", "languageCode" ] } }, "required": [ "projectId", "scope" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "quote_local_research", "title": "Quote a local rank grid or public posts", "description": "Free quote. Choose a stable business CID/place ID, country, and coordinates for 9 or 25-point grid. Standard queue only. Review usage/temporary hold with the user before running; cross-border grids are unsupported.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "input": { "anyOf": [ { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "countryCode": { "default": "US", "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "languageCode": { "default": "en", "type": "string", "minLength": 2, "maxLength": 10 }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "cid", "place_id" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 200 }, "label": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "kind", "value", "label" ], "additionalProperties": false }, "kind": { "type": "string", "const": "grid" }, "keyword": { "type": "string", "minLength": 1, "maxLength": 700 }, "latitude": { "type": "number", "minimum": -85, "maximum": 85 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "size": { "default": 3, "anyOf": [ { "type": "number", "const": 3 }, { "type": "number", "const": 5 } ] }, "spacingMeters": { "default": 1000, "type": "integer", "minimum": 100, "maximum": 5000 }, "zoom": { "default": 14, "type": "integer", "minimum": 4, "maximum": 18 }, "depth": { "default": 20, "anyOf": [ { "type": "number", "const": 10 }, { "type": "number", "const": 20 } ] }, "coordinatesConfirmed": { "type": "boolean", "const": true, "description": "Confirm the points are in the selected country. Cross-border grids are not supported." } }, "required": [ "projectId", "target", "kind", "keyword", "latitude", "longitude", "coordinatesConfirmed" ], "additionalProperties": false }, { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "countryCode": { "default": "US", "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "languageCode": { "default": "en", "type": "string", "minLength": 2, "maxLength": 10 }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "cid", "place_id" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 200 }, "label": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "kind", "value", "label" ], "additionalProperties": false }, "kind": { "type": "string", "const": "posts" }, "depth": { "default": 10, "anyOf": [ { "type": "number", "const": 10 }, { "type": "number", "const": 20 }, { "type": "number", "const": 50 } ] } }, "required": [ "projectId", "target", "kind" ], "additionalProperties": false } ] } }, "required": [ "projectId", "input" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "quote_opportunity_research", "title": "Quote guided SEO opportunity research", "description": "Quote saved-data review and selective keyword, competitor, backlink, AI, local and shortlisted verification checks. budgetCredits uses 1000 credits per dollar; zero is saved-only and the maximum is $10. Return the full plan and temporary hold to the user and obtain explicit consent before starting.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "budgetCredits": { "type": "integer", "minimum": 0, "maximum": 10000 }, "focus": { "default": "balanced", "type": "string", "enum": [ "balanced", "content", "links", "ai", "local" ] } }, "required": [ "projectId", "budgetCredits" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "quote_prompt_answer_analysis", "title": "Quote saved-answer interpretation", "description": "Free quote for one optional, tool-free saved-answer interpretation. Does not collect an answer or fetch a source. Check enabled before asking for approval; an operator can pause the module.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "quote_prompt_discovery", "title": "Quote question discovery", "description": "Quote US-English ChatGPT dataset question discovery and optional single SERP relevance check. Free; estimates are not measured consumer AI usage.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "topic": { "type": "string", "minLength": 2, "maxLength": 100 }, "brandDomain": { "type": "string", "minLength": 3, "maxLength": 253 }, "source": { "default": "chatgpt_us_dataset", "type": "string", "const": "chatgpt_us_dataset" }, "limit": { "default": 25, "anyOf": [ { "type": "number", "const": 25 }, { "type": "number", "const": 50 }, { "type": "number", "const": 100 } ] }, "enrichSerp": { "default": false, "type": "boolean" } }, "required": [ "projectId", "topic" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "quote_prompt_monitor", "title": "Quote exact-prompt checks", "description": "Free quote. Supply configId for a saved monitor to receive a revision-bound quoteToken valid for 15 minutes, required by run_prompt_monitor. Or supply inventory and optional measurement for a setup estimate. No paid requests or schedule changes.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "inventory": { "type": "object", "properties": { "topics": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "prompts": { "minItems": 1, "maxItems": 25, "type": "array", "items": { "type": "string", "minLength": 3, "maxLength": 700 } } }, "required": [ "name", "prompts" ] } }, "engines": { "minItems": 1, "maxItems": 6, "type": "array", "items": { "type": "string", "enum": [ "chatgpt", "gemini", "google_overview", "google_ai_mode", "claude", "perplexity" ] } }, "competitors": { "default": [], "maxItems": 5, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 2, "maxLength": 100 }, "domain": { "type": "string", "minLength": 3, "maxLength": 253 } }, "required": [ "label", "domain" ] } } }, "required": [ "topics", "engines" ] }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "measurement": { "type": "object", "properties": { "deliveryMode": { "default": "live", "type": "string", "enum": [ "live", "standard" ] }, "samplesPerPrompt": { "default": 1, "type": "integer", "minimum": 1, "maximum": 3 }, "chatgptSearchPolicy": { "default": "forced", "type": "string", "enum": [ "forced", "natural" ] }, "answerAnalysisEnabled": { "default": false, "type": "boolean" } }, "additionalProperties": false } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "quote_prompt_source_research", "title": "Quote cited-page research", "description": "Free estimate for a separately approved source-page action. Up to 20 URLs already observed in an owned run; no source fetch, model call or recurring enrollment. Check enabled for fetching and interpretationEnabled before adding page interpretation. Quotes do not enable modules.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "pages": { "type": "integer", "minimum": 1, "maximum": 20 }, "analyze": { "default": false, "type": "boolean" } }, "required": [ "projectId", "pages" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "quote_rank_recovery", "title": "Review missing-device rank recovery", "description": "Free saved-data read. Return exactly the recoverable keyword/device pairs, current revision, maximum usage and temporary authorization credits. Unknown provider outcomes cannot be repurchased. Pass this review to run_rank_check only after approving the hold.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keywordIds": { "maxItems": 2000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "recoveryRunId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "configId", "recoveryRunId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "reanalyze_prompt_monitor_run", "title": "Reanalyze retained prompt evidence", "description": "Create an idempotent new matching interpretation from saved answers, citations and frozen targets. Original claims and answer text stay unchanged. Free, no provider research.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "configId", "runId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "reconcile_local_research", "title": "Check accepted local tasks", "description": "Free bounded collection of known tasks for a reconciling job. Cannot buy replacements or replay a lost task submission. Unknown submissions need operator review.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "runId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "reconcile_prompt_monitor_run", "title": "Reconcile retained prompt checks", "description": "Free bounded final-status check for up to two original checks in an owned stopped run. A still-active row requires its existing workflow to be confirmed terminal. Reuses Standard task receipts or proven terminal manual-review decisions, never buys answers again. Unknown requests remain reserved for review.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "configId", "runId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "reconcile_rank_check", "title": "Collect accepted rank tasks", "description": "Free bounded collection of at most three original tasks from a partial, failed or confirmed stopped owned run. A still-active row requires its existing workflow to be confirmed terminal. Reconciles original receipt/credits only, never buys replacement research. Repeat only while original tasks need confirmation.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keywordIds": { "maxItems": 2000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "recoveryRunId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "configId", "recoveryRunId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "refresh_saved_keyword_metrics", "title": "Refresh saved keyword metrics", "description": "Refresh metrics for saved project keywords. This can run paid research across the saved list; agree on the workload and balance first.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "refresh_tracking_metrics", "title": "Refresh tracking keyword metrics", "description": "Fetch updated search volume, CPC and difficulty for the tracker’s keywords. Paid provider calls use the account balance.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "configId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "remove_page_target", "title": "Remove page target assignment", "description": "Remove a keyword assignment from this page while retaining the saved keyword and its history. No paid calls.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "pageId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keywordId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "pageId", "keywordId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "remove_saved_keywords", "title": "Remove saved keywords", "description": "Remove selected saved keywords from this project. Confirm the keyword selection first. No provider charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "savedKeywordIds": { "minItems": 1, "maxItems": 2000, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "projectId", "savedKeywordIds" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "remove_tracking_keywords", "title": "Remove tracking keywords", "description": "Remove specific keyword IDs from this project’s tracker. Confirm keywords before removal.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keywordIds": { "minItems": 1, "maxItems": 2000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } } }, "required": [ "projectId", "configId", "keywordIds" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "rename_keyword_tag", "title": "Rename keyword tag", "description": "Rename a project keyword tag. No provider charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "tagId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 64 }, "color": { "anyOf": [ { "type": "string", "enum": [ "slate", "rose", "amber", "lime", "emerald", "sky", "violet", "fuchsia" ] }, { "type": "null" } ] } }, "required": [ "projectId", "tagId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "rename_prompt_monitor_topic", "title": "Rename a prompt topic", "description": "Rename a project-bound topic with an expected collection revision. Free; historical topic labels and answers stay unchanged.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "topicId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "projectId", "configId", "expectedRevision", "topicId", "name" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "research_keywords", "title": "Research keywords (bulk)", "description": "Research keyword data (search volume, optional AI-search volume, difficulty, CPC, related ideas) for 1-5 seed keywords in one call. Charges credits per seed and returns per-seed results so one bad seed does not fail the batch.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "seeds": { "minItems": 1, "maxItems": 5, "type": "array", "items": { "type": "object", "properties": { "seed": { "type": "string", "minLength": 1, "maxLength": 700, "description": "Seed keyword to research." }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "seed" ] }, "description": "1-5 seed keywords. Each seed is researched independently and returns related keywords with volume/difficulty/CPC. Bulk-friendly — prefer this over multiple single-seed calls." }, "resultLimit": { "description": "Max keywords returned per seed. Defaults to 150.", "anyOf": [ { "type": "number", "const": 150 }, { "type": "number", "const": 300 }, { "type": "number", "const": 500 } ] }, "includeClickstreamData": { "description": "Refine search volumes with clickstream data, which disaggregates Google Ads' grouped close-variant volumes (plurals/misspellings). DOUBLES the credit cost of each seed. Default false (standard Google-Ads-derived volumes). No effect for countries served from Google Ads data.", "type": "boolean" }, "includeAiData": { "description": "Include estimated AI-search volume and monthly AI trends. Adds one batched research request per seed. Defaults to false.", "type": "boolean" } }, "required": [ "projectId", "seeds" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "results": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "seed": { "type": "string" }, "ok": { "type": "boolean", "const": true }, "rowCount": { "type": "number" }, "source": { "type": "string" }, "usedFallback": { "type": "boolean" }, "rows": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } } }, "required": [ "seed", "ok", "rowCount", "source", "usedFallback", "rows" ], "additionalProperties": {} }, { "type": "object", "properties": { "seed": { "type": "string" }, "ok": { "type": "boolean", "const": false }, "error": { "type": "string" } }, "required": [ "seed", "ok", "error" ], "additionalProperties": {} } ] } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "results" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "research_prompt_questions", "title": "Find data-backed questions", "description": "Acquire bounded US-English ChatGPT dataset questions under a reviewed price/hold. Optional single SERP check; no retries or auto-enrichment on reads. Adds nothing to a monitor and collects no monitor answers. Confirm paid approval first.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "topic": { "type": "string", "minLength": 2, "maxLength": 100 }, "brandDomain": { "type": "string", "minLength": 3, "maxLength": 253 }, "source": { "default": "chatgpt_us_dataset", "type": "string", "const": "chatgpt_us_dataset" }, "limit": { "default": 25, "anyOf": [ { "type": "number", "const": 25 }, { "type": "number", "const": 50 }, { "type": "number", "const": 100 } ] }, "enrichSerp": { "default": false, "type": "boolean" }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "idempotencyKey", "projectId", "topic", "confirmedCeilingCredits" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "topic": { "type": "string" }, "countryCode": { "type": "string", "const": "US" }, "languageCode": { "type": "string", "const": "en" }, "platform": { "type": "string", "const": "chatgpt_dataset" }, "fetchedAt": { "type": "string" }, "relevanceCoverage": { "type": "string", "enum": [ "dataset", "dataset_and_serp", "reduced" ] }, "warnings": { "type": "array", "items": { "type": "string" } }, "suggestions": { "type": "array", "items": { "type": "object", "properties": { "question": { "type": "string", "minLength": 3, "maxLength": 700 }, "variants": { "maxItems": 10, "type": "array", "items": { "type": "string", "maxLength": 700 } }, "source": { "type": "string", "const": "dataset" }, "estimatedAiSearchVolume": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "citations": { "maxItems": 2, "type": "array", "items": { "type": "string", "maxLength": 2048 } }, "citationsTruncated": { "default": false, "type": "boolean" }, "ownBrandCited": { "type": "boolean" }, "relevance": { "type": "string", "enum": [ "topic", "own_citation", "serp_domain" ] } }, "required": [ "question", "variants", "source", "estimatedAiSearchVolume", "citations", "citationsTruncated", "ownBrandCited", "relevance" ], "additionalProperties": false } } }, "required": [ "topic", "countryCode", "languageCode", "platform", "fetchedAt", "relevanceCoverage", "warnings", "suggestions" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "research_prompt_sources", "title": "Research saved cited pages", "description": "Explicit paid action for 1–20 public unsigned URLs from an owned saved prompt run. Respects robots, public-only transport and bounded redirects/bytes. Reuses project-owned snapshots for free; charges only usable fresh pages and valid optional interpretations. Never sends outreach or publishes. Requires stable retry identity and reviewed hold. Check quote availability; model labels require supporting-text review.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "runId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "urls": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 2048, "format": "uri" } }, "analyze": { "default": false, "type": "boolean" }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "idempotencyKey", "projectId", "configId", "runId", "urls", "confirmedCeilingCredits" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "selected": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fetched": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "reused": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "blocked": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pages": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fetchedAt": { "type": "string" }, "truncated": { "type": "boolean" }, "analysisStatus": { "type": "string" } }, "required": [ "id", "url", "title", "fetchedAt", "truncated", "analysisStatus" ], "additionalProperties": false } } }, "required": [ "selected", "fetched", "reused", "blocked", "pages" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "restore_project", "title": "Restore project", "description": "Restore an archived project by projectId. Free; requires all-project write/management permission and a stable external idempotencyKey.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" }, "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." } }, "required": [ "projectId", "idempotencyKey" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "resume_keyword_import", "title": "Continue saved import batch", "description": "Apply the next bounded chunk of the actor's saved import. Completed rows are checkpoints; retries do not duplicate them. Rechecks current project/market/access and pauses on changes. No paid calls.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "batchId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "batchId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "revoke_report_recipient", "title": "Stop report recipient delivery", "description": "Manager only. Stop future reports to a specific saved recipient. Optionally revoke that recipient's issued share links. Confirm the recipient and link revocation with the user; no charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "recipientId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "revokeIssuedLinks": { "type": "boolean" } }, "required": [ "projectId", "recipientId", "revokeIssuedLinks" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "revoke_saved_report_share", "title": "Revoke public report link", "description": "Immediately revoke the specified public saved-report link. Workspace managers only; no usage charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "reportId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "shareId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "projectId", "reportId", "shareId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "boolean" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "run_aio_monitor", "title": "Run AI visibility check", "description": "Start a paid check for an active monitor. Uses normal balance authorization and duplicate-run protection. Read get_aio_monitoring for run status and saved history.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "idempotencyKey", "projectId", "configId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "run_competitor_watch", "title": "Run competitor monitoring", "description": "Start one funded check with a confirmed quote, current revision and stable UUID idempotency key. Wallet and monthly cap are reserved before research. Reuse the key on retries. Returns the saved run ID; poll get_competitor_watch_run without buying another run.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "watchId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "confirmedCeilingCredits": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "idempotencyKey", "projectId", "watchId", "confirmedCeilingCredits", "revision" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "run_local_research", "title": "Start reviewed local research", "description": "Paid native saved job. Requires a reviewed current quote, stable requestId for retries, exact confirmed maximum hold and price version. Never submit from a restored draft or silently use a new requestId after lost acknowledgment. Returns a saved job, not provider task IDs. No recurring work.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "input": { "anyOf": [ { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "countryCode": { "default": "US", "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "languageCode": { "default": "en", "type": "string", "minLength": 2, "maxLength": 10 }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "cid", "place_id" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 200 }, "label": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "kind", "value", "label" ], "additionalProperties": false }, "kind": { "type": "string", "const": "grid" }, "keyword": { "type": "string", "minLength": 1, "maxLength": 700 }, "latitude": { "type": "number", "minimum": -85, "maximum": 85 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "size": { "default": 3, "anyOf": [ { "type": "number", "const": 3 }, { "type": "number", "const": 5 } ] }, "spacingMeters": { "default": 1000, "type": "integer", "minimum": 100, "maximum": 5000 }, "zoom": { "default": 14, "type": "integer", "minimum": 4, "maximum": 18 }, "depth": { "default": 20, "anyOf": [ { "type": "number", "const": 10 }, { "type": "number", "const": 20 } ] }, "coordinatesConfirmed": { "type": "boolean", "const": true, "description": "Confirm the points are in the selected country. Cross-border grids are not supported." } }, "required": [ "projectId", "target", "kind", "keyword", "latitude", "longitude", "coordinatesConfirmed" ], "additionalProperties": false }, { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "countryCode": { "default": "US", "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "languageCode": { "default": "en", "type": "string", "minLength": 2, "maxLength": 10 }, "target": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "cid", "place_id" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 200 }, "label": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "kind", "value", "label" ], "additionalProperties": false }, "kind": { "type": "string", "const": "posts" }, "depth": { "default": 10, "anyOf": [ { "type": "number", "const": 10 }, { "type": "number", "const": 20 }, { "type": "number", "const": 50 } ] } }, "required": [ "projectId", "target", "kind" ], "additionalProperties": false } ] }, "requestId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "priceVersion": { "type": "string", "const": "local-2026-10-14-v1" }, "confirmedMaxCredits": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "quoteExpiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "input", "requestId", "priceVersion", "confirmedMaxCredits", "quoteExpiresAt", "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "run_prompt_monitor", "title": "Run exact-prompt checks", "description": "Start one fresh, paid consumer-search collection after confirming its quoted hold. No cached answers are reused. Single active run; unused held credits released. Saved history is free.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "quoteToken": { "type": "string", "maxLength": 2000 } }, "required": [ "idempotencyKey", "projectId", "configId", "confirmedCeilingCredits" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "run_rank_check", "title": "Run rank check", "description": "Start an asynchronous paid rank check. Uses normal balance authorization and duplicate-run protection. Optionally restrict to keywordIds. For missing-device recovery, first call quote_rank_recovery and pass recoveryRunId, expectedRevision and confirmedCeilingCredits; saved successful pairs are excluded. Returns runId or already_running; use get_rank_tracker to read status/results.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keywordIds": { "maxItems": 2000, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "recoveryRunId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "idempotencyKey", "projectId", "configId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "run_site_audit", "title": "Run site audit", "description": "Start a site audit: crawls the site (robots.txt-aware, same-origin), checks every page for SEO issues (broken links, duplicate/missing titles and descriptions, redirect chains, orphan pages, canonical problems, thin content, and more), and optionally runs Lighthouse on a sample of pages. Runs in the background — poll get_audit_status, then read get_audit_issues. If the site blocks our crawler, pages are honestly flagged as blocked rather than misreported.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "url": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "Start URL to crawl." }, "maxPages": { "description": "Page budget for the crawl (default 500).", "type": "integer", "minimum": 10, "maximum": 10000 }, "runLighthouse": { "description": "Run Lighthouse on a sample of up to 10 representative pages (default true).", "type": "boolean" }, "renderJavascript": { "description": "Opt-in rendered DOM crawl. Adds per-page usage and a bounded hold. Default false.", "type": "boolean" }, "crawlerAuthorizationId": { "description": "Previously verified Shopify authorization for this project and exact hostname. HTML mode only; set runLighthouse=false.", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "idempotencyKey", "projectId", "url" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "auditId": { "type": "string" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "auditId" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "save_audit_schedule", "title": "Create or update audit schedule", "description": "Schedule weekly or monthly site audits, or update one with scheduleId. Future runs incur normal audit/Lighthouse usage charges. Agree on URL, maxPages, Lighthouse and frequency first.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "startUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxPages": { "default": 500, "type": "integer", "minimum": 10, "maximum": 10000 }, "lighthouseStrategy": { "default": "auto", "type": "string", "enum": [ "auto", "none" ] }, "renderJavascript": { "type": "boolean" }, "crawlerAuthorizationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "scheduleId": { "type": "string", "minLength": 1 }, "scheduleInterval": { "type": "string", "enum": [ "weekly", "monthly" ] }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "startUrl", "scheduleInterval" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "save_implementation_proposal", "title": "Save a proposed change", "description": "Save a versioned title, meta, internal-link or content proposal with project-owned links and current assignee/reviewer access. This is instructions for a user, not CMS publishing. It invalidates earlier approval. No generation charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "opportunityId": { "type": "string", "minLength": 1 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "title", "meta", "internal_link", "content" ] }, "sourceUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "targetUrl": { "anyOf": [ { "type": "string", "maxLength": 2048, "format": "uri" }, { "type": "null" } ] }, "proposedText": { "type": "string", "minLength": 1, "maxLength": 2500 }, "placement": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "reason": { "type": "string", "minLength": 1, "maxLength": 1000 }, "pageId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "briefId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "assigneeMemberId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "reviewerMemberId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "projectId", "opportunityId", "revision", "kind", "sourceUrl", "targetUrl", "proposedText", "placement", "reason", "pageId", "briefId", "assigneeMemberId", "reviewerMemberId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "save_keywords", "title": "Save keywords", "description": "Save keywords to a project's saved-keywords list. Uses no credits — does not make a paid research request. Idempotent: re-saving an existing keyword is a no-op. If tags are provided, missing tags may be created. By default tags are appended; set tagMode=replace to remove existing tags from these saved keywords before applying the provided tags, which is useful for reorganizing keywords into page/topic clusters. Ask the user for confirmation before applying or replacing tags broadly.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "keywords": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "minLength": 1 }, "description": "Keywords to save (1-100)." }, "tags": { "description": "Optional tags to attach to every saved keyword. Ask the user for explicit confirmation before using this, especially when saving many keywords or creating new tag names.", "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "tagMode": { "description": "How to apply tags. Defaults to append. Use replace to remove existing tags from these saved keywords before applying the provided tags.", "type": "string", "enum": [ "append", "replace" ] }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991, "description": "Deprecated numeric market identifier for existing clients. Prefer countryCode, such as US, GB or DE. Omit both to use the project market. Keyword difficulty, intent and domain analytics are not available in every market.", "deprecated": true }, "languageCode": { "type": "string", "description": "Language code (e.g. 'en', 'es', 'vi'). Defaults to the project's default market language (see list_projects)." } }, "required": [ "projectId", "keywords" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "projectId": { "type": "string" }, "savedCount": { "type": "number" }, "keywords": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "tagMode": { "type": "string", "enum": [ "append", "replace" ] }, "locationCode": { "type": "number" }, "countryCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "languageCode": { "type": "string" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "projectId", "savedCount", "keywords", "tags", "tagMode", "locationCode", "countryCode", "country", "languageCode" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "save_report_sections", "title": "Save private report sections", "description": "Save finished narrative/table/citation blocks as a private immutable report version using existing saved report IDs as evidence. No paid data refresh or inference occurs in this tool; writing in chat uses its approved generation budget. Use requestId/seriesId stable UUIDs; initial expectedRevision=0, expectedParentReportId=null. Further versions need the current series/revision/parent. Never retry an uncertain save with a new requestId. HTML, images, embeds, unsafe links and oversized tables are rejected. Public sharing is a separate explicit consent action.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "requestId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "seriesId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 10000 }, "expectedParentReportId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "title": { "type": "string", "minLength": 1, "maxLength": 160 }, "sourceReportIds": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "blocks": { "minItems": 1, "maxItems": 40, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "heading" }, "text": { "type": "string", "minLength": 1, "maxLength": 160 }, "level": { "default": 2, "anyOf": [ { "type": "number", "const": 2 }, { "type": "number", "const": 3 } ] } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "paragraph" }, "text": { "type": "string", "minLength": 1, "maxLength": 4000 } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "list" }, "items": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 1000 } } }, "required": [ "type", "items" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "table" }, "title": { "type": "string", "minLength": 1, "maxLength": 160 }, "headers": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "string", "const": "" } ] } }, "rows": { "maxItems": 100, "type": "array", "items": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 500 }, { "type": "string", "const": "" } ] } } } }, "required": [ "type", "title", "headers", "rows" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "citation" }, "label": { "type": "string", "minLength": 1, "maxLength": 200 }, "url": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "type", "label", "url" ], "additionalProperties": false } ] } } }, "required": [ "projectId", "requestId", "seriesId", "expectedRevision", "expectedParentReportId", "title", "sourceReportIds", "blocks" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "reportId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "seriesId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "replayed": { "type": "boolean" }, "researchChargeCredits": { "type": "number", "const": 0 } }, "required": [ "reportId", "seriesId", "revision", "replayed", "researchChargeCredits" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "score_content_draft", "title": "Score and save a content draft", "description": "Score draft coverage against a saved brief and persist the draft and score. Replaces that brief’s previous draft. No provider call or usage charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "briefId": { "type": "string", "minLength": 1 }, "draftContent": { "type": "string", "minLength": 100, "maxLength": 100000 } }, "required": [ "projectId", "briefId", "draftContent" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "search_app_listings", "title": "Search app listings", "description": "Find Google Play or Apple App Store listings with ratings, reviews, installs, developer, and category data. Uses credits when called.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "store": { "type": "string", "enum": [ "google_play", "app_store" ] }, "query": { "type": "string", "minLength": 1, "maxLength": 200 }, "limit": { "default": 10, "type": "integer", "minimum": 1, "maximum": 20 } }, "required": [ "projectId", "store", "query" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "store": { "type": "string" }, "query": { "type": "string" }, "totalCount": { "type": "number" }, "items": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "fetchedAt": { "type": "string" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "store", "query", "totalCount", "items", "fetchedAt" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": {} }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "search_local_businesses", "title": "Search local businesses", "description": "Searches local business listings near a coordinate. Use this to find local business candidates or nearby competitors; it does not run Maps rank checks or Q&A. Charges credits.", "inputSchema": { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "description": "Required. The FlexQueries project ID to scope this call to. Get one from list_projects." }, "query": { "description": "Business name or title text to match.", "type": "string", "minLength": 1, "maxLength": 200 }, "near": { "type": "object", "properties": { "latitude": { "type": "number", "minimum": -90, "maximum": 90, "description": "Latitude of the search center." }, "longitude": { "type": "number", "minimum": -180, "maximum": 180, "description": "Longitude of the search center." }, "radiusKm": { "type": "number", "minimum": 1, "maximum": 100000, "description": "Search radius around the center, in kilometers." } }, "required": [ "latitude", "longitude", "radiusKm" ], "description": "Coordinate and radius to search around." }, "categories": { "description": "Business categories to filter by (e.g. 'pizza_restaurant').", "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 } }, "limit": { "description": "Maximum businesses to return (1-50). Defaults to 20.", "type": "integer", "minimum": 1, "maximum": 50 } }, "required": [ "projectId", "near" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "businesses": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "businesses" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "set_audit_schedule_active", "title": "Pause or resume audit schedule", "description": "Set a project audit schedule active or paused. Resuming permits future paid scheduled runs.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "scheduleId": { "type": "string", "minLength": 1 }, "isActive": { "type": "boolean" }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "scheduleId", "isActive" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "set_competitor_watch_active", "title": "Pause or resume competitor watch", "description": "Pause future checks or resume the existing scope after confirming its current quote. Pausing does not cancel charges for work already in flight. Resuming weekly monitoring requires explicit consent.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "watchId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "active": { "type": "boolean" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "watchId", "active", "revision", "confirmedCeilingCredits" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "set_monitoring_active", "title": "Pause or approve a saved schedule", "description": "Pause a project schedule or resume its exact current revision and per-run quote. Resuming enables future charges, not an immediate run. Obtain explicit agreement to cadence, scope and ceiling; workspace/member/project caps still apply. Report delivery requires manager access and approved recipients.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "feature": { "type": "string", "enum": [ "rank_tracking", "site_audit", "ai_visibility", "opportunities", "competitor_watch", "reports" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 100 }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "enabled": { "type": "boolean" }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "feature", "id", "revision", "enabled", "confirmedCeilingCredits" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "set_outcome_settings", "title": "Configure outcome events", "description": "Owner/Admin only. Select 1–10 already observed/configured GA4 events using the current settings revision and property. Goal changes do not rewrite historical evidence. No paid calls.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "propertyId": { "type": "string", "pattern": "^\\d+$" }, "label": { "type": "string", "minLength": 1, "maxLength": 100 }, "events": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_]{0,39}$" } }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "propertyId", "label", "events", "revision" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "set_page_target", "title": "Assign intended page keyword", "description": "Assign a saved project keyword as primary or supporting. Primary replaces the prior primary assignment only on this page. No enrichment or charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "pageId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "keywordId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "role": { "type": "string", "enum": [ "primary", "supporting" ] } }, "required": [ "projectId", "pageId", "keywordId", "role" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "set_prompt_monitor_aliases", "title": "Confirm brand aliases", "description": "Save up to nine explicitly confirmed names for future checks only. Require the collection revision. Common words can overstate mentions; confirm with the user. Free, no collection or historical rewriting.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "aliases": { "default": [], "maxItems": 9, "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 100 } } }, "required": [ "projectId", "configId", "expectedRevision" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "set_prompt_monitor_prompt", "title": "Archive or restore tracked prompt", "description": "Archive a prompt without deleting history, or restore it with a reviewed per-run ceiling. A restored prompt has the same immutable text and engines.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "promptId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "archived": { "type": "boolean" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "configId", "promptId", "archived", "expectedRevision" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "set_report_delivery", "title": "Configure approved report delivery", "description": "Manager only. Save the current delivery revision, calendar/timezone and enabled state. Enabling requires verified identity and an approved recipient. Delivery uses saved evidence, not new paid research; obtain agreement before changing schedules.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "enabled": { "type": "boolean" }, "cadence": { "type": "string", "enum": [ "weekly", "monthly" ] }, "timeZone": { "type": "string", "enum": [ "UTC", "America/New_York", "America/Los_Angeles", "Europe/London", "Europe/Berlin", "Asia/Dhaka", "Asia/Kolkata", "Asia/Singapore", "Australia/Sydney" ] }, "hour": { "default": 9, "anyOf": [ { "type": "number", "const": 9 }, { "type": "number", "const": 13 } ] }, "monthDay": { "type": "integer", "minimum": 1, "maximum": 31 } }, "required": [ "projectId", "revision", "enabled", "cadence", "timeZone", "monthDay" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "start_keyword_import", "title": "Start confirmed keyword import", "description": "Persist an explicitly reviewed CSV import using a stable UUID idempotency key. Saves keywords or a paused/manual tracker only; does not enqueue rank checks, metrics refreshes or recurring work. Do not infer permission to spend from this import.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "csv": { "type": "string", "minLength": 1, "maxLength": 2097152 }, "mapping": { "type": "object", "properties": { "keyword": { "type": "integer", "minimum": 0, "maximum": 31 }, "location": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 31 }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 31 }, { "type": "null" } ] }, "tags": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 31 }, { "type": "null" } ] }, "target": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 31 }, { "type": "null" } ] }, "device": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 31 }, { "type": "null" } ] } }, "required": [ "keyword", "location", "language", "tags", "target", "device" ] }, "destination": { "type": "string", "enum": [ "saved", "tracking" ] }, "configId": { "default": null, "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "defaults": { "type": "object", "properties": { "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 1, "maxLength": 10 }, "devices": { "default": "both", "type": "string", "enum": [ "desktop", "mobile", "both" ] } }, "required": [ "locationCode", "languageCode" ] } }, "required": [ "idempotencyKey", "projectId", "csv", "mapping", "destination", "defaults" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "start_opportunity_research", "title": "Start approved opportunity research", "description": "Start one background job only after explicit user approval of quote_opportunity_research. Pass its exact quoteKey, cap and a stable UUID idempotencyKey. Reserve the quoted temporary hold; charge only successful checks and release unused funds. No automatic paid retries. Reuse the key after network errors and poll get_opportunity_research rather than starting again.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "budgetCredits": { "type": "integer", "minimum": 0, "maximum": 10000 }, "focus": { "default": "balanced", "type": "string", "enum": [ "balanced", "content", "links", "ai", "local" ] }, "quoteKey": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "idempotencyKey", "projectId", "budgetCredits", "quoteKey" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "suggest_monitoring_prompts", "title": "Draft questions to track", "description": "Return editable topic templates, not measured AI demand. Free. Combine with saved keyword research or customer questions before adding them to a prompt collection.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "topic": { "type": "string", "minLength": 2, "maxLength": 100 } }, "required": [ "projectId", "topic" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "sync_saved_pages", "title": "Synchronize retained page records", "description": "Copy one bounded chunk of retained audit/Opportunity evidence into Pages. Repeat with nextCursor until null; preserve capped coverage. This never recrawls or starts paid enrichment.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "cursor": { "default": null, "anyOf": [ { "type": "object", "properties": { "auditId": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "phase": { "type": "string", "enum": [ "audit", "opportunities" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 975, "multipleOf": 25 }, "startedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "capped": { "type": "boolean" } }, "required": [ "auditId", "phase", "offset", "startedAt", "capped" ] }, { "type": "null" } ] } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "sync_search_console_pages", "title": "Synchronize Search Console page evidence", "description": "Retrieve and save one bounded chunk of project-owned Search Console pages after current grant checks. Repeat with nextCursor until null. Does not spend FlexQueries credits; missing pages or metrics are not zero.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "cursor": { "default": null, "anyOf": [ { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 975, "multipleOf": 25 }, "startDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "endDate": { "type": "string", "format": "date", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$" }, "connectionSignature": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "offset", "startDate", "endDate", "connectionSignature" ] }, { "type": "null" } ] } }, "required": [ "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "update_aio_monitor", "title": "Update AI visibility monitor", "description": "Change platforms, schedule, alerts, or active state of a project monitor. Pausing stops future scheduled checks; enabling or changing schedules can incur future usage charges.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "platforms": { "minItems": 1, "maxItems": 2, "type": "array", "items": { "type": "string", "enum": [ "chat_gpt", "google" ] } }, "scheduleInterval": { "type": "string", "enum": [ "weekly", "monthly", "manual" ] }, "alertsEnabled": { "type": "boolean" }, "isActive": { "type": "boolean" }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "configId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "update_competitor_watch", "title": "Update competitor watch settings", "description": "Replace a saved watch's scope with a confirmed full quote and cap. Requires the current revision and no active run. Changed settings establish a new baseline; history is retained. Saving weekly monitoring authorizes future paid checks and requires explicit user consent.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100 }, "scope": { "type": "object", "properties": { "domain": { "type": "string", "minLength": 1, "maxLength": 253 }, "rivals": { "minItems": 1, "maxItems": 3, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 } }, "locationCode": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "minLength": 2, "maxLength": 8 }, "rankings": { "default": true, "type": "boolean" }, "links": { "default": false, "type": "boolean" }, "content": { "default": false, "type": "boolean" }, "ai": { "default": false, "type": "boolean" }, "aiHistory": { "default": false, "type": "boolean" } }, "required": [ "domain", "rivals", "locationCode", "languageCode" ] }, "cadence": { "type": "string", "enum": [ "manual", "weekly" ] }, "monthlyCapCredits": { "type": "integer", "minimum": 50, "maximum": 100000 }, "confirmedCeilingCredits": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "watchId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "scope", "cadence", "monthlyCapCredits", "confirmedCeilingCredits", "watchId", "revision" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "update_project", "title": "Update project", "description": "Replace a project name/domain and optionally its market. Omitted domain clears it. Requires management and explicit write permission. External agents must send idempotencyKey. Free.", "inputSchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "domain": { "type": "string", "maxLength": 255 }, "country_code": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." }, "language_code": { "type": "string", "maxLength": 10 }, "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } }, "required": [ "name", "idempotencyKey", "projectId" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" }, "name": { "type": "string" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language_code": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "domain", "country_code", "country", "language_code", "created_at" ], "additionalProperties": false } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "update_prompt_monitor", "title": "Manage prompt monitor", "description": "Pause, resume, archive or change a prompt monitor frequency. Revision required; resume/schedule changes require the reviewed ceiling. Archives retain history.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "isActive": { "type": "boolean" }, "archive": { "type": "boolean", "const": true }, "scheduleInterval": { "type": "string", "enum": [ "manual", "daily", "weekly", "monthly" ] }, "measurement": { "type": "object", "properties": { "deliveryMode": { "default": "live", "type": "string", "enum": [ "live", "standard" ] }, "samplesPerPrompt": { "default": 1, "type": "integer", "minimum": 1, "maximum": 3 }, "chatgptSearchPolicy": { "default": "forced", "type": "string", "enum": [ "forced", "natural" ] }, "answerAnalysisEnabled": { "default": false, "type": "boolean" } }, "additionalProperties": false }, "schedule": { "type": "object", "properties": { "timeZone": { "type": "string", "minLength": 1, "maxLength": 100 }, "hour": { "type": "integer", "minimum": 0, "maximum": 23 }, "minute": { "default": 0, "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "default": 1, "type": "integer", "minimum": 0, "maximum": 6 }, "dayOfMonth": { "default": 1, "type": "integer", "minimum": 1, "maximum": 31 }, "monthlyLimitCredits": { "type": "integer", "minimum": 50, "maximum": 1000000 } }, "required": [ "timeZone", "hour", "monthlyLimitCredits" ] }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "configId", "expectedRevision" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "update_prompt_monitor_inventory", "title": "Manage tracked prompts in bulk", "description": "Move, pause/resume or archive/restore up to 25 explicitly selected prompt IDs. Revision required. Resume/restore requires the current ceiling; saved answers/topics remain immutable. Free settings change, not collection.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "promptIds": { "minItems": 1, "maxItems": 25, "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "action": { "type": "string", "enum": [ "move", "pause", "resume", "archive", "restore" ] }, "topicId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "confirmedCeilingCredits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "configId", "expectedRevision", "promptIds", "action" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "update_rank_tracker", "title": "Update rank tracker", "description": "Update domain, market, devices, depth, schedule or active state. Changes affect future paid checks; confirm configuration with the user.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "configId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "domain": { "type": "string", "minLength": 1, "maxLength": 253 }, "locationCode": { "description": "Deprecated numeric market alias for existing clients. Prefer countryCode, such as US, GB or DE.", "deprecated": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "languageCode": { "type": "string", "maxLength": 10 }, "locationName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "devices": { "type": "string", "enum": [ "both", "desktop", "mobile" ] }, "serpDepth": { "type": "integer", "minimum": 10, "maximum": 100, "multipleOf": 10 }, "scheduleInterval": { "type": "string", "enum": [ "daily", "weekly", "monthly", "manual" ] }, "scheduleTime": { "type": "object", "properties": { "timeZone": { "type": "string", "minLength": 1, "maxLength": 100 }, "hour": { "type": "integer", "minimum": 0, "maximum": 23 }, "minute": { "default": 0, "type": "integer", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "default": 1, "type": "integer", "minimum": 0, "maximum": 6 }, "dayOfMonth": { "default": 1, "type": "integer", "minimum": 1, "maximum": 31 } }, "required": [ "timeZone", "hour" ] }, "isActive": { "type": "boolean" }, "maxRunCredits": { "type": "integer", "minimum": 0, "maximum": 100000000 }, "countryCode": { "type": "string", "description": "ISO country code, such as US, GB or DE. Defaults to the project market when omitted." } }, "required": [ "projectId", "configId" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "update_saved_keyword_tags", "title": "Edit saved keyword tags", "description": "Add or remove tags on selected saved keywords. Project-scoped; no provider charge.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "savedKeywordIds": { "minItems": 1, "maxItems": 2000, "type": "array", "items": { "type": "string", "minLength": 1 } }, "addTags": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "removeTagIds": { "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "projectId", "savedKeywordIds" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": true, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } }, { "name": "verify_implementation_proposal", "title": "Check approved website change", "description": "Run one bounded robots-respecting public-page check for the approved current revision. Returns match, mismatch, unavailable or manual_review; never changes the website or guarantees ranking improvements. Requires user agreement to check; concurrent checks are deduplicated.", "inputSchema": { "type": "object", "properties": { "idempotencyKey": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[a-zA-Z0-9_-]+$", "description": "Stable retry identity. Reuse the same value and inputs after a lost response; never use a new identity to retry an uncertain start." }, "projectId": { "type": "string", "minLength": 1 }, "opportunityId": { "type": "string", "minLength": 1 }, "revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "projectId", "opportunityId", "revision" ], "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/__schema0" }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "data" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "__schema0": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/definitions/__schema0" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/definitions/__schema0" } } ] } } }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "openWorldHint": true }, "execution": { "taskSupport": "forbidden" } }, { "name": "whoami", "title": "Who am I", "description": "Returns the authenticated user, organization, server mode, token scopes, and current credit balance. Uses no credits — does not make a paid research request. Use this first to confirm connection context before choosing a project or running paid tools.", "inputSchema": { "type": "object", "properties": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "outputSchema": { "type": "object", "properties": { "userId": { "type": "string" }, "userEmail": { "type": "string" }, "organizationId": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "mode": { "type": "string", "enum": [ "hosted", "self-hosted" ] }, "balanceUsd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "meta": { "type": "object", "properties": { "url": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "runId": { "type": "string" }, "chargedUsd": { "type": "number" }, "balanceUsd": { "type": "number" } }, "additionalProperties": {} } }, "required": [ "userId", "userEmail", "organizationId", "scopes", "mode", "balanceUsd" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "openWorldHint": false }, "execution": { "taskSupport": "forbidden" } } ] }