{ "info": { "name": "Promptwatch API", "description": "Promptwatch Customer API - V1 and V2 endpoints.\n\n## Authentication\n\nAll requests require an **X-API-Key** header with your API key (automatically added via collection auth).\n\n### Project-Level vs Organization-Level API Keys\n\n**Project-Level Keys:** Automatically use the associated project. X-Project-Id header is ignored if provided.\n\n**Organization-Level Keys:** Require **X-Project-Id** header for most endpoints to specify which project to operate on.\n\n### X-Project-Id Header Requirements\n\n**V1 API:** All endpoints require X-Project-Id when using organization-level API keys.\n\n**V2 API:**\n- **Required:** All endpoints except GET/POST /projects\n- **Not Required:** GET /projects and POST /projects (these are org-level only, no project context needed)\n\n### How to Use X-Project-Id\n\n1. Set the `projectId` collection variable to your project UUID\n2. The X-Project-Id header is already enabled on all requests that require it\n3. You can view and edit the header value in the Headers tab of each request\n4. If using project-level API keys, the header is ignored by the server\n\n### Array Parameters\n\nFor parameters that accept multiple values (promptTypes, intentTypes, referrerDomains, models, domains, promptIds, crawlers, statusCodes on GET /api/v2/analytics/crawlers/events), use repeated keys: `param=value1¶m=value2`\n\n### Analytics Visitors (60-Day Limit)\n\nAnalytics visitor endpoints (total, trend, referrer-stats, top-browsers, top-devices, top-locations, top-pages, top-sources) limit the date range to 60 days. Requests exceeding this will return 400.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "http://localhost:3001", "type": "string" }, { "key": "apiKey", "value": "YOUR_API_KEY_HERE", "type": "string", "description": "Your API key from Promptwatch dashboard" }, { "key": "projectId", "value": "", "type": "string", "description": "Your project UUID. Required when using organization-level API keys. Set this value and the X-Project-Id header will use it automatically." }, { "key": "contentPromptId", "value": "", "type": "string", "description": "LLM prompt UUID for POST /api/v2/content/create (from GET /api/v2/prompts)." }, { "key": "contentPersonaId", "value": "", "type": "string", "description": "Persona UUID for POST /api/v2/content/create (from GET /api/v2/personas)." }, { "key": "contentDocumentId", "value": "", "type": "string", "description": "Document UUID from POST /api/v2/content/create; use for GET /api/v2/content/:id." }, { "key": "actionId", "value": "", "type": "string", "description": "Action item UUID from GET /api/v2/actions; use for PATCH /api/v2/actions/:id." }, { "key": "trackedPageId", "value": "", "type": "string", "description": "Tracked page UUID from POST /api/v2/page-tracker; use for GET/DELETE /api/v2/page-tracker/:id and sub-resources." }, { "key": "trackedPageUrl", "value": "https://vegan-deals.co.uk", "type": "string", "description": "URL to track in Page Tracker POST requests." }, { "key": "trackedPageStartDate", "value": "", "type": "string", "description": "Optional start date (YYYY-MM-DD, UTC) for Page Tracker stats/sub-resources. Defaults to today when omitted." }, { "key": "trackedPageEndDate", "value": "", "type": "string", "description": "Optional end date (YYYY-MM-DD, UTC) for Page Tracker stats/sub-resources. Defaults to today when omitted." } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "event": [], "item": [ { "name": "V1 API", "item": [ { "name": "Authentication", "description": "API key validation and authentication", "item": [ { "name": "Validate API Key", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/validate", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } } ] }, { "name": "Models", "description": "Available LLM models", "item": [ { "name": "Get Models", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/models", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } } ] }, { "name": "Monitors", "description": "Monitor management and data", "item": [ { "name": "Get Monitors", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/monitors", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } } ] }, { "name": "Visibility", "description": "Visibility data and insights", "item": [ { "name": "Get Visibility Time Series", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/v1/visibility-time-series?range=day", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "visibility-time-series" ], "query": [ { "key": "range", "value": "day", "description": "day, week, or month" }, { "key": "model", "value": "", "disabled": true }, { "key": "llmMonitorId", "value": "", "disabled": true }, { "key": "promptId", "value": "", "disabled": true } ] }, "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Competitor Heatmap", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/competitor-heatmap", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } } ] }, { "name": "Citations", "description": "Citation analytics and source tracking", "item": [ { "name": "Get Citations", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/citations", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Citations Self Frequency", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/citations/self-frequency", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Citations Domains Over Time", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/citations/domains-over-time", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Citations Rank Analysis", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/citations/rank-analysis", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Citations Top Pages", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/citations/top-pages", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Citations LLM Sources", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/citations/llm-sources", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Citations Domains By LLM", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/citations/domains-by-llm", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } } ] }, { "name": "Prompts", "description": "Prompt management and operations", "item": [ { "name": "Get Prompts", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/prompts", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Prompt by ID", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/v1/prompts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "prompts", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Prompt UUID" } ] }, "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } } ] }, { "name": "Analytics", "description": "Analytics data and insights", "item": [ { "name": "Get Sentiment Time Series", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/v1/sentiment-time-series?range=day", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "sentiment-time-series" ], "query": [ { "key": "range", "value": "day" }, { "key": "model", "value": "", "disabled": true }, { "key": "llmMonitorId", "value": "", "disabled": true } ] }, "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Visitors Total", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/analytics/visitors/total", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Visitors Trend", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/analytics/visitors/trend", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Crawlers Trend", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/analytics/crawlers/trend", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Crawlers Top Pages", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/analytics/crawlers/top-pages", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Brands Visibility Over Time", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/v1/analytics/brands/visibility-over-time?range=daily", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "analytics", "brands", "visibility-over-time" ], "query": [ { "key": "range", "value": "daily", "description": "daily, weekly, or monthly" } ] }, "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } } ] }, { "name": "Share of Voice", "description": "Share of voice analytics showing brand mentions vs total responses", "item": [ { "name": "Get Share of Voice Time Series", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/v1/share-of-voice/time-series?range=day", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "share-of-voice", "time-series" ], "query": [ { "key": "range", "value": "day" } ] }, "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Share of Voice Comparison", "request": { "method": "GET", "url": { "raw": "{{baseUrl}}/api/v1/share-of-voice/comparison?range=day", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "share-of-voice", "comparison" ], "query": [ { "key": "range", "value": "day" } ] }, "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } } ] }, { "name": "Responses", "description": "Response analytics including mentions, competitors, and sentiment", "item": [ { "name": "Get Responses Summary", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/responses/summary", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Responses Mentions Time Series", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/responses/mentions-time-series", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Responses Competitors", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/responses/competitors", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Responses Sentiment Distribution", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/responses/sentiment-distribution", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } }, { "name": "Get Responses Sentiment Time Series", "request": { "method": "GET", "url": "{{baseUrl}}/api/v1/responses/sentiment-time-series", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ] } } ] } ] }, { "name": "V2 API", "item": [ { "name": "Authentication", "description": "API key validation and authentication", "item": [ { "name": "Validate API Key", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/auth/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "auth", "validate" ] }, "description": "Validates an API key and returns associated project/organization details. Returns key type (project or organization), project info, and available projects for org-level keys. For organization-level keys, you can optionally provide X-Project-Id header to validate against a specific project." }, "response": [ { "name": "Success - Project Key", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/auth/validate" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"valid\": true,\n \"keyType\": \"project\",\n \"project\": {\n \"id\": \"uuid\",\n \"name\": \"My Project\",\n \"slug\": \"my-project\"\n },\n \"organization\": {\n \"id\": \"uuid\",\n \"name\": \"My Organization\",\n \"slug\": \"my-org\"\n },\n \"apiKey\": {\n \"id\": \"uuid\",\n \"name\": \"My API Key\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"lastUsedAt\": \"2024-01-01T00:00:00.000Z\"\n }\n}" }, { "name": "Success - Organization Key", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/auth/validate" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"valid\": true,\n \"keyType\": \"organization\",\n \"project\": null,\n \"organization\": {\n \"id\": \"uuid\",\n \"name\": \"My Organization\",\n \"slug\": \"my-org\"\n },\n \"apiKey\": {\n \"id\": \"uuid\",\n \"name\": \"My API Key\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"lastUsedAt\": \"2024-01-01T00:00:00.000Z\"\n },\n \"availableProjects\": [\n {\n \"id\": \"uuid\",\n \"name\": \"Project 1\",\n \"slug\": \"project-1\"\n }\n ]\n}" }, { "name": "Invalid API Key", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "invalid-key" } ], "url": { "raw": "{{baseUrl}}/api/v2/auth/validate" } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "body": "{\n \"valid\": false,\n \"message\": \"Invalid API key\"\n}" } ] } ] }, { "name": "Models", "description": "Available LLM models supported by Promptwatch", "item": [ { "name": "Get Models", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/models?includeDeprecated=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "models" ], "query": [ { "key": "includeDeprecated", "value": "false", "description": "Include deprecated models in the response", "disabled": true } ] }, "description": "Returns all available LLM models supported by Promptwatch. Each model includes provider information, API identifier, search capabilities (searchEnabled, liveSearch), and deprecation status. Use includeDeprecated=true to see all models including deprecated ones." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/models" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"models\": [\n {\n \"id\": \"openai_gpt-4o\",\n \"label\": \"GPT-4o\",\n \"provider\": \"openai\",\n \"providerName\": \"OpenAI\",\n \"modelName\": \"gpt-4o\",\n \"apiIdentifier\": \"gpt-4o\",\n \"description\": \"OpenAI's GPT-4o model\",\n \"searchEnabled\": true,\n \"liveSearch\": true,\n \"deprecated\": false\n },\n {\n \"id\": \"google_gemini-pro\",\n \"label\": \"Gemini Pro\",\n \"provider\": \"google\",\n \"providerName\": \"Google\",\n \"modelName\": \"gemini-pro\",\n \"apiIdentifier\": \"gemini-pro\",\n \"description\": \"Google's Gemini Pro model\",\n \"searchEnabled\": true,\n \"liveSearch\": false,\n \"deprecated\": false\n }\n ],\n \"total\": 2\n}" } ] } ] }, { "name": "Monitors", "description": "Monitor management and CRUD operations", "item": [ { "name": "Get Monitors", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/monitors?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "monitors" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD). Defaults to 7 days ago.", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD). Defaults to today.", "disabled": true } ] }, "description": "Returns all active monitors for the project with visibility metrics. Includes average visibility, response counts, and prompt counts within the specified date range. Only returns active monitors." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/monitors" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "[\n {\n \"id\": \"uuid\",\n \"name\": \"My Monitor\",\n \"description\": \"Monitor description\",\n \"active\": true,\n \"models\": [\"openai_gpt-4o\", \"google_gemini-pro\"],\n \"languageCode\": \"en-US\",\n \"countryCode\": \"US\",\n \"promptCount\": 10,\n \"responseCount\": 150,\n \"responseCountInRange\": 50,\n \"averageVisibility\": 75.5,\n \"personaName\": null,\n \"personaDescription\": null,\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2024-01-01T00:00:00.000Z\"\n }\n]" } ] }, { "name": "Get Monitor by ID", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/monitors/:id?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "monitors", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Monitor UUID" } ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true } ] }, "description": "Returns a single monitor by ID with full details and metrics including visibility scores, response counts, and associated persona information." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/monitors/:id" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"id\": \"uuid\",\n \"name\": \"My Monitor\",\n \"description\": \"Monitor description\",\n \"active\": true,\n \"models\": [\"openai_gpt-4o\"],\n \"languageCode\": \"en-US\",\n \"countryCode\": \"US\",\n \"promptCount\": 10,\n \"responseCount\": 150,\n \"responseCountInRange\": 50,\n \"averageVisibility\": 75.5,\n \"personaName\": \"Tech Enthusiast\",\n \"personaDescription\": \"Tech-savvy user\",\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2024-01-01T00:00:00.000Z\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/monitors/:id" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"error\": \"Not Found\",\n \"message\": \"Monitor with ID uuid not found\"\n}" } ] }, { "name": "Create Monitor", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"My New Monitor\",\n \"description\": \"Monitor description\",\n \"models\": [\"openai_gpt-4o\", \"google_gemini-pro\"],\n \"languageCode\": \"en-US\",\n \"countryCode\": \"US\",\n \"stateCode\": null,\n \"cityCode\": null,\n \"personaId\": null,\n \"initialPrompts\": [],\n \"generatePrompts\": [\n {\n \"amount\": 3,\n \"type\": \"ORGANIC\",\n \"instructions\": \"Focus on how buyers evaluate solutions in this space.\"\n },\n {\n \"amount\": 2,\n \"type\": \"BRAND_SPECIFIC\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/monitors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "monitors" ] }, "description": "Creates a new LLM monitor for the project. Optional `initialPrompts` supplies explicit prompts (each needs prompt, type, intent, keywords). Optional `generatePrompts` is a list of up to three independent generation batches (one per prompt type); batches run in parallel and do not receive each other's or initial prompts as LLM context. Each batch requires `amount` (1\u201350 prompts); optional `type` biases the generator; optional `instructions` steers the batch (max 500 characters). The sum of all batch amounts must be \u2264 50 per request. You can use `initialPrompts`, `generatePrompts`, both, or neither. Persona and location fields apply as in the schema. Returns the created monitor; the monitor is active by default." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"My New Monitor\",\n \"models\": [\"openai_gpt-4o\"],\n \"generatePrompts\": [{ \"amount\": 5, \"type\": \"ORGANIC\" }]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/monitors" } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "body": "{\n \"id\": \"uuid\",\n \"name\": \"My New Monitor\",\n \"description\": \"Monitor description\",\n \"active\": true,\n \"models\": [\"openai_gpt-4o\", \"google_gemini-pro\"],\n \"languageCode\": \"en-US\",\n \"countryCode\": \"US\",\n \"promptCount\": 0,\n \"responseCount\": 0,\n \"responseCountInRange\": 0,\n \"averageVisibility\": 0,\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2024-01-01T00:00:00.000Z\"\n}" } ] }, { "name": "Update Monitor", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Monitor Name\",\n \"description\": \"Updated description\",\n \"active\": true,\n \"models\": [\"openai_gpt-4o\"],\n \"languageCode\": \"en-US\",\n \"countryCode\": \"US\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/monitors/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "monitors", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Monitor UUID to update" } ] }, "description": "Updates an existing monitor's properties. All fields are optional - only include fields you want to update. Returns the updated monitor with current metrics." }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Monitor Name\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/monitors/:id" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"id\": \"uuid\",\n \"name\": \"Updated Monitor Name\",\n \"description\": \"Updated description\",\n \"active\": true,\n \"models\": [\"openai_gpt-4o\"],\n \"languageCode\": \"en-US\",\n \"countryCode\": \"US\",\n \"promptCount\": 10,\n \"responseCount\": 150,\n \"responseCountInRange\": 50,\n \"averageVisibility\": 75.5,\n \"createdAt\": \"2024-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2024-01-01T00:00:00.000Z\"\n}" } ] }, { "name": "Delete Monitor", "request": { "method": "DELETE", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/monitors/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "monitors", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Monitor UUID to delete" } ] }, "description": "Soft-deletes a monitor by ID. The monitor will be marked as inactive and removed from active listings. Returns 204 No Content on success." }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/monitors/:id" } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "body": "" } ] } ] }, { "name": "Page Tracker", "description": "Track URLs and inspect citation stats, responses, and prompts that cite each page", "item": [ { "name": "List Tracked Pages", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker?page=1&size=10&startDate={{trackedPageStartDate}}&endDate={{trackedPageEndDate}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "page-tracker" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)" }, { "key": "size", "value": "10", "description": "Page size (max 100)" }, { "key": "search", "value": "", "description": "Filter by URL substring", "disabled": true }, { "key": "startDate", "value": "{{trackedPageStartDate}}", "description": "First inclusive UTC calendar day (YYYY-MM-DD). Defaults to today when omitted.", "disabled": true }, { "key": "endDate", "value": "{{trackedPageEndDate}}", "description": "Last inclusive UTC calendar day (YYYY-MM-DD). Defaults to today when omitted.", "disabled": true } ] }, "description": "Returns a paginated list of tracked pages with citation stats (promptCount, citationCount, lastCitedAt) scoped to the requested date range. Both startDate and endDate default to today (UTC) when omitted. Pages with zero citations in the range are still listed with counts of 0." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"pages\": [\n {\n \"id\": \"6ba7b822-9dad-11d1-80b4-00c04fd430c8\",\n \"url\": \"https://example.com/pricing\",\n \"title\": \"Pricing\",\n \"domainName\": \"example.com\",\n \"createdAt\": \"2026-03-15T10:00:00.000Z\",\n \"promptCount\": 12,\n \"citationCount\": 28,\n \"lastCitedAt\": \"2026-03-28T14:30:00.000Z\"\n }\n ],\n \"total\": 1,\n \"page\": 1,\n \"size\": 10,\n \"totalPages\": 1\n}" } ] }, { "name": "Add Tracked Page", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"{{trackedPageUrl}}\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/page-tracker", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "page-tracker" ] }, "description": "Track a single URL. Returns 400 TRACKED_PAGE_ALREADY_EXISTS if the project already tracks this URL." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/pricing\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/page-tracker" } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "body": "{\n \"id\": \"6ba7b822-9dad-11d1-80b4-00c04fd430c8\",\n \"url\": \"https://example.com/pricing\",\n \"title\": \"Pricing\",\n \"domainName\": \"example.com\",\n \"createdAt\": \"2026-03-15T10:00:00.000Z\"\n}" }, { "name": "Already Exists", "originalRequest": { "method": "POST", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/pricing\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/page-tracker" } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "body": "{\n \"code\": \"TRACKED_PAGE_ALREADY_EXISTS\",\n \"message\": \"This URL is already being tracked\"\n}" } ] }, { "name": "Get Tracked Page", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker/:id?startDate={{trackedPageStartDate}}&endDate={{trackedPageEndDate}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "page-tracker", ":id" ], "variable": [ { "key": "id", "value": "{{trackedPageId}}", "description": "Tracked page UUID" } ], "query": [ { "key": "startDate", "value": "{{trackedPageStartDate}}", "description": "Start date (YYYY-MM-DD). Defaults to today when omitted." }, { "key": "endDate", "value": "{{trackedPageEndDate}}", "description": "End date (YYYY-MM-DD). Defaults to today when omitted." } ] }, "description": "Returns a tracked page with citation stats (promptCount, citationCount, lastCitedAt) for an inclusive UTC date range. When startDate and endDate are omitted, defaults to today only. Future dates return 400 DATE_RANGE_IN_FUTURE." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker/:id" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"id\": \"6ba7b822-9dad-11d1-80b4-00c04fd430c8\",\n \"url\": \"https://example.com/pricing\",\n \"title\": \"Pricing\",\n \"domainName\": \"example.com\",\n \"createdAt\": \"2026-03-15T10:00:00.000Z\",\n \"promptCount\": 12,\n \"citationCount\": 28,\n \"lastCitedAt\": \"2026-03-28T14:30:00.000Z\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker/:id" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"code\": \"TRACKED_PAGE_NOT_FOUND\",\n \"message\": \"Tracked page not found\"\n}" } ] }, { "name": "Get Tracked Page (default date range)", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "page-tracker", ":id" ], "variable": [ { "key": "id", "value": "{{trackedPageId}}", "description": "Tracked page UUID" } ] }, "description": "Same as Get Tracked Page but omits startDate/endDate (defaults to today only, UTC)." }, "response": [] }, { "name": "List Tracked Page Responses", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker/:id/responses?page=1&size=10&startDate={{trackedPageStartDate}}&endDate={{trackedPageEndDate}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "page-tracker", ":id", "responses" ], "variable": [ { "key": "id", "value": "{{trackedPageId}}", "description": "Tracked page UUID" } ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)" }, { "key": "size", "value": "10", "description": "Page size (max 100)" }, { "key": "startDate", "value": "{{trackedPageStartDate}}", "description": "Start date (YYYY-MM-DD). Defaults to today when omitted." }, { "key": "endDate", "value": "{{trackedPageEndDate}}", "description": "End date (YYYY-MM-DD). Defaults to today when omitted." } ] }, "description": "Returns paginated LLM responses that cited this tracked page within an inclusive UTC date range. When dates are omitted, defaults to today only." }, "response": [] }, { "name": "List Tracked Page Responses (default date range)", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker/:id/responses?page=1&size=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "page-tracker", ":id", "responses" ], "variable": [ { "key": "id", "value": "{{trackedPageId}}", "description": "Tracked page UUID" } ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)" }, { "key": "size", "value": "10", "description": "Page size (max 100)" } ] }, "description": "Responses citing this page with default date range (today only, UTC)." }, "response": [] }, { "name": "List Tracked Page Prompts", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker/:id/prompts?page=1&size=10&startDate={{trackedPageStartDate}}&endDate={{trackedPageEndDate}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "page-tracker", ":id", "prompts" ], "variable": [ { "key": "id", "value": "{{trackedPageId}}", "description": "Tracked page UUID" } ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)" }, { "key": "size", "value": "10", "description": "Page size (max 100)" }, { "key": "startDate", "value": "{{trackedPageStartDate}}", "description": "Start date (YYYY-MM-DD). Defaults to today when omitted." }, { "key": "endDate", "value": "{{trackedPageEndDate}}", "description": "End date (YYYY-MM-DD). Defaults to today when omitted." } ] }, "description": "Returns paginated prompts whose responses cited this tracked page within an inclusive UTC date range. When dates are omitted, defaults to today only." }, "response": [] }, { "name": "List Tracked Page Prompts (default date range)", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker/:id/prompts?page=1&size=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "page-tracker", ":id", "prompts" ], "variable": [ { "key": "id", "value": "{{trackedPageId}}", "description": "Tracked page UUID" } ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based)" }, { "key": "size", "value": "10", "description": "Page size (max 100)" } ] }, "description": "Prompts citing this page with default date range (today only, UTC)." }, "response": [] }, { "name": "Delete Tracked Page", "request": { "method": "DELETE", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "page-tracker", ":id" ], "variable": [ { "key": "id", "value": "{{trackedPageId}}", "description": "Tracked page UUID to delete" } ] }, "description": "Stops tracking a page by tracked page id. Returns deletedCount." }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker/:id" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "body": "{\n \"deletedCount\": 1\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "X-API-Key", "value": "{{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/api/v2/page-tracker/:id" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "body": "{\n \"code\": \"TRACKED_PAGE_NOT_FOUND\",\n \"message\": \"Tracked page not found\"\n}" } ] } ] }, { "name": "Visibility", "description": "Visibility data and insights", "item": [ { "name": "Get Visibility Time Series", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/visibility-time-series?range=day&startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "visibility-time-series" ], "query": [ { "key": "range", "value": "day", "description": "Time range: day, week, or month", "disabled": true }, { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "models", "value": "", "description": "Repeat for multiple: models=openai_gpt-4o&models=google_gemini-pro", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true } ] }, "description": "Returns brand visibility time series data. Shows how your brand's visibility score changes over time across different LLM models. Supports filtering by model, monitor, or prompt." } }, { "name": "Get Competitor Heatmap", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/competitor-heatmap?startDate=&endDate=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "competitor-heatmap" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "model", "value": "", "description": "Filter by model", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "limit", "value": "50", "description": "Limit number of competitors (default: 50)", "disabled": true }, { "key": "excludeSelf", "value": "false", "description": "Exclude own brand (default: false)", "disabled": true }, { "key": "hideIgnoredBrands", "value": "true", "description": "Hide ignored brands (default: true)", "disabled": true } ] }, "description": "Returns competitor visibility heatmap data across models. Shows a matrix of competitors (rows) vs models (columns) with visibility percentages. Useful for comparing competitor performance across different LLM models." } } ] }, { "name": "Citations", "description": "Citation analytics and source tracking", "item": [ { "name": "Get Citations", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/citations?startDate=&endDate=&limit=20&page=1&size=20", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "citations" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "models", "value": "", "description": "Filter by LLM models. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptTypes", "value": "", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true }, { "key": "limit", "value": "20", "description": "Max domain results (1-100, default: 20)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number for URL results (1-indexed, default: 1)", "disabled": true }, { "key": "size", "value": "20", "description": "URL results per page (1-250, default: 20)", "disabled": true }, { "key": "domains", "value": "", "description": "Filter by cited domains. Repeat for multiple: domains=example.com&domains=other.com", "disabled": true } ] }, "description": "Returns citation analytics including top domains, URLs, authority metrics, and page rank data. Supports pagination (page, size) for URL results and domain filtering (domains). Includes total estimated traffic, average authority scores, summary statistics, and pagination metadata. Shows which sources LLMs cite most frequently." } }, { "name": "Get Grouped Citations", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/citations/grouped?page=1&size=25&sortBy=count&sortOrder=desc", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "citations", "grouped" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-indexed, default: 1)", "disabled": true }, { "key": "size", "value": "25", "description": "Results per page (1-100, default: 25)", "disabled": true }, { "key": "sortBy", "value": "count", "description": "Sort field: count | avgPosition | minPosition | maxPosition | domainRank | domainAuthorityScore | estimatedTraffic | pageRank | domainName | url (default: count)", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "Sort order: asc | desc (default: desc)", "disabled": true }, { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "models", "value": "", "description": "Filter by LLM models. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptTypes", "value": "", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple", "disabled": true }, { "key": "domains", "value": "", "description": "Filter by cited domains. Repeat for multiple", "disabled": true }, { "key": "tagIds", "value": "", "description": "Filter by prompt tag IDs. Repeat for multiple", "disabled": true }, { "key": "topicIds", "value": "", "description": "Filter by topic IDs. Repeat for multiple", "disabled": true }, { "key": "contentTypes", "value": "", "description": "Filter by URL content type (e.g. HOW_TO, REVIEW, LISTICLE). Repeat for multiple", "disabled": true }, { "key": "sourceTypes", "value": "", "description": "Filter by URL source type (e.g. BLOG, NEWS, YOUTUBE). Repeat for multiple", "disabled": true }, { "key": "urlSearch", "value": "", "description": "Search within cited URL / title / domain", "disabled": true }, { "key": "hideIgnoredBrands", "value": "", "description": "Exclude domains belonging to ignored brands (true/false)", "disabled": true } ] }, "description": "Returns a paginated, sortable table of cited URLs. Each row includes the URL and its domain metadata (domain rank/DR, authority score, estimated traffic), citation count, average/best/worst position, and the models/providers citing the page. Mirrors the citations dashboard table. Supports rich filtering by date range, model, prompt type, tags, topics, content/source type, domain, URL search, and ignored brands." } }, { "name": "Get Citations Self Frequency", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/citations/self-frequency?range=DAILY&granularity=daily&startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "citations", "self-frequency" ], "query": [ { "key": "range", "value": "DAILY", "description": "Time range: DAILY, WEEKLY, or MONTHLY", "disabled": true }, { "key": "granularity", "value": "daily", "description": "Granularity: daily, weekly, or monthly", "disabled": true }, { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "model", "value": "", "description": "Filter by model", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptTypes", "value": "", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true } ] }, "description": "Returns self-citation frequency over time for your own domain. Shows how often your domain is cited by LLMs over time, helping track citation trends." } }, { "name": "Get Citations Domains Over Time", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/citations/domains-over-time?range=DAILY&granularity=daily&domainLimit=10&startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "citations", "domains-over-time" ], "query": [ { "key": "range", "value": "DAILY", "description": "Time range: DAILY, WEEKLY, or MONTHLY", "disabled": true }, { "key": "granularity", "value": "daily", "description": "Granularity: daily, weekly, or monthly", "disabled": true }, { "key": "domainLimit", "value": "10", "description": "Limit number of domains (default: 10)", "disabled": true }, { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "models", "value": "", "description": "Filter by LLM models. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptTypes", "value": "", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true }, { "key": "domains", "value": "", "description": "Filter by domains. Repeat for multiple: domains=example.com&domains=other.com", "disabled": true }, { "key": "includeSelf", "value": "false", "description": "If true, always include project's own domain (even with 0 citations)", "disabled": true } ] }, "description": "Returns domain citation frequency over time for top domains. Supports domain filter (domains) to restrict to specific domains. Shows how citation counts for different domains change over time, helping identify trending sources." } }, { "name": "Get Citations Rank Analysis", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/citations/rank-analysis?range=DAILY&startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "citations", "rank-analysis" ], "query": [ { "key": "range", "value": "DAILY", "description": "Time range: DAILY, WEEKLY, or MONTHLY", "disabled": true }, { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "model", "value": "", "description": "Filter by model", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptTypes", "value": "", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true } ] }, "description": "Returns citation rank analysis for your domain over time. Shows your domain's average rank position when cited by LLMs, helping track citation performance." } }, { "name": "Get Citations Top Pages", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/citations/top-pages?startDate=&endDate=&limit=100", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "citations", "top-pages" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "model", "value": "", "description": "Filter by model", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptTypes", "value": "", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true }, { "key": "limit", "value": "100", "description": "Limit number of pages (default: 100)", "disabled": true } ] }, "description": "Returns top cited pages with average rank. Shows which specific pages/URLs are cited most frequently by LLMs, along with their average citation rank." } }, { "name": "Get Citations LLM Sources", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/citations/llm-sources?startDate=&endDate=&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "citations", "llm-sources" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "model", "value": "", "description": "Filter by model", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptTypes", "value": "", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true }, { "key": "limit", "value": "10", "description": "Limit number of sources (default: 10)", "disabled": true } ] }, "description": "Returns top LLM sources with citation statistics. Shows which LLM models cite sources most frequently, helping understand citation patterns across different models." } }, { "name": "Get Citations Domains By LLM", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/citations/domains-by-llm?startDate=&endDate=&limit=20", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "citations", "domains-by-llm" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "model", "value": "", "description": "Filter by model", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptTypes", "value": "", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true }, { "key": "limit", "value": "20", "description": "Limit number of domains per LLM (default: 20)", "disabled": true } ] }, "description": "Returns domain citations grouped by LLM source. Shows which domains each LLM model cites most frequently, helping compare citation patterns across different models." } } ] }, { "name": "Content Gap", "description": "Content gap analysis and recommendations. Optional startDate and endDate (YYYY-MM-DD, UTC) limit stats and list rows to the latest content gap run per prompt whose created_at falls in that inclusive day range. Omit dates for all-time latest per prompt. startDate must be on or before endDate or the API returns 400.", "item": [ { "name": "Get Content Gap Stats", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/content-gap/stats?promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC&startDate=2026-01-01&endDate=2026-01-31", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "content-gap", "stats" ], "query": [ { "key": "promptTypes", "value": "ORGANIC", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true }, { "key": "promptTypes", "value": "BRAND_SPECIFIC", "description": "Second value", "disabled": true }, { "key": "startDate", "value": "2026-01-01", "description": "Optional. YYYY-MM-DD (UTC). Only count analyses with created_at on or after this day.", "disabled": true }, { "key": "endDate", "value": "2026-01-31", "description": "Optional. YYYY-MM-DD (UTC). Only count analyses with created_at on or before this day. 400 if startDate > endDate.", "disabled": true } ] }, "description": "Returns aggregate content coverage statistics for the project. Includes total prompts with/without coverage, average score, distribution (low/medium/good/excellent), and breakdowns by prompt type and intent type.\n\nWhen startDate/endDate are set, each prompt contributes at most one score: the latest content gap in that analysis date window. Omit both for all-time latest per prompt." } }, { "name": "Get Content Gap Prompts", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/content-gap/prompts?page=1&size=25&promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC&intentTypes=INFORMATIONAL&tagIds=6ba7b811-9dad-11d1-80b4-00c04fd430c8&sortBy=contentCoverageScore&sortOrder=desc&startDate=2026-01-01&endDate=2026-01-31", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "content-gap", "prompts" ], "query": [ { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "25", "description": "Page size (default: 25, max: 100)", "disabled": true }, { "key": "query", "value": "", "description": "Text search on prompt", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true }, { "key": "promptTypes", "value": "BRAND_SPECIFIC", "description": "Second prompt type", "disabled": true }, { "key": "intentTypes", "value": "INFORMATIONAL", "description": "Repeat for multiple: intentTypes=INFORMATIONAL&intentTypes=COMMERCIAL", "disabled": true }, { "key": "tagIds", "value": "6ba7b811-9dad-11d1-80b4-00c04fd430c8", "description": "Prompt tag ID. Repeat for multiple: tagIds=uuid1&tagIds=uuid2", "disabled": true }, { "key": "hasCoverage", "value": "", "description": "Filter by coverage (true/false)", "disabled": true }, { "key": "sortBy", "value": "contentCoverageScore", "description": "contentCoverageScore or createdAt", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "asc or desc", "disabled": true }, { "key": "startDate", "value": "2026-01-01", "description": "Optional. YYYY-MM-DD (UTC). latestContentGap is the newest run in this window per prompt.", "disabled": true }, { "key": "endDate", "value": "2026-01-31", "description": "Optional. YYYY-MM-DD (UTC). 400 if startDate > endDate.", "disabled": true } ] }, "description": "Returns paginated list of prompts with content gap scores. Each item includes latestContentGap (score, sitemap stats, query fanouts count) when a run exists in scope.\n\nOptional startDate/endDate restrict to the latest analysis per prompt whose created_at falls in that UTC day range; prompts with no run in range get latestContentGap null. Omit dates for all-time latest per prompt." } }, { "name": "Get Content Gap Latest", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/content-gap/prompts/:promptId/latest", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "content-gap", "prompts", ":promptId", "latest" ], "variable": [ { "key": "promptId", "value": "", "description": "Prompt UUID" } ] }, "description": "Returns the latest content coverage result for a prompt. Returns null if the prompt has no content coverage yet. Includes score, explanation, report, sources, queryFanouts, and recommendations." } }, { "name": "Get Content Gap Recommendations", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/content-gap/prompts/:promptId/latest/recommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "content-gap", "prompts", ":promptId", "latest", "recommendations" ], "variable": [ { "key": "promptId", "value": "", "description": "Prompt UUID" } ] }, "description": "Returns content recommendations from the latest content gap analysis. Each recommendation includes title, action (CREATE/OPTIMIZE), details, priority, impact, effort, and suggested sections." } } ] }, { "name": "Content", "description": "AI content documents: list jobs, start async generation (CREATE or OPTIMIZE), poll status by id. Set collection variables contentPromptId and contentPersonaId before POST /content/create; copy id from the response into contentDocumentId for GET /content/:id.", "item": [ { "name": "List Content", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/content?page=1&size=25&orderBy=createdAt&sortOrder=desc", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "content" ], "query": [ { "key": "page", "value": "1", "description": "Page number (1-based, default 1)", "disabled": true }, { "key": "size", "value": "25", "description": "Page size (1\u2013100, default 25); same param name as other v2 list endpoints", "disabled": true }, { "key": "orderBy", "value": "createdAt", "description": "createdAt or updatedAt", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "asc or desc", "disabled": true }, { "key": "mode", "value": "", "description": "Optional filter: CREATE or OPTIMIZE", "disabled": true }, { "key": "status", "value": "", "description": "Optional filter: PENDING, IN_PROGRESS, COMPLETED, FAILED, STOPPED", "disabled": true } ] }, "description": "Paginated list of content documents. Response includes total, page, size, totalPages (aligned with other v2 lists). Each row includes id, status, mode, type, title (persisted when set; often null until complete), promptId, prompt, and timestamps; omits generated markdown body." } }, { "name": "Create Content (CREATE mode)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"CREATE\",\n \"promptId\": \"{{contentPromptId}}\",\n \"personaId\": \"{{contentPersonaId}}\",\n \"type\": \"ARTICLE\",\n \"contentLength\": \"SHORT\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/content/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "content", "create" ] }, "description": "Starts new AI content generation from a prompt. Returns 201 with id and status PENDING. Poll GET /content/:id until COMPLETED, FAILED, or STOPPED. Types: ARTICLE, BLOG_POST, PRODUCT_PAGE, GENERIC_CONTENT, LISTICLE, PRODUCT_COMPARISON. Lengths: SHORT, MEDIUM, LONG. Optional: contentGapRecommendationId (from content-gap recommendations), toneOfVoice + customToneOfVoice when tone is CUSTOM." } }, { "name": "Create Content (OPTIMIZE mode)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"OPTIMIZE\",\n \"promptId\": \"{{contentPromptId}}\",\n \"personaId\": \"{{contentPersonaId}}\",\n \"optimizationLevel\": \"MEDIUM\",\n \"url\": \"https://your-site.com/path\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/content/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "content", "create" ] }, "description": "Optimizes existing page content; URL must be a page in the project sitemap with markdown. optimizationLevel: LOW, MEDIUM, or HIGH." } }, { "name": "Get Content by ID", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/content/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "content", ":id" ], "variable": [ { "key": "id", "value": "{{contentDocumentId}}", "description": "Document UUID from POST /content/create (or set contentDocumentId collection variable)" } ] }, "description": "Returns one document: status, mode, type, title (persisted when set), promptId, prompt, content when available, timestamps. Use for polling after create." } } ] }, { "name": "Prompts", "description": "Prompt management and operations", "item": [ { "name": "Get Prompts", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/prompts?page=1&size=10&sortBy=createdAt&sortOrder=desc", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts" ], "query": [ { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "10", "description": "Page size (default: 10)", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "query", "value": "", "description": "Search query", "disabled": true }, { "key": "isActive", "value": "", "description": "Filter by active status (true/false)", "disabled": true }, { "key": "types", "value": "", "description": "Filter by prompt types (ORGANIC, BRAND_SPECIFIC, COMPETITOR_COMPARISON)", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Sort field (default: createdAt)", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "Sort order (asc/desc)", "disabled": true } ] }, "description": "Returns paginated list of prompts with search and filtering options. Supports filtering by monitor, active status, type, and search query. Includes visibility metrics, volume, and difficulty scores." } }, { "name": "Get Prompt by ID", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/prompts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Prompt UUID" } ] }, "description": "Returns a single prompt by ID with full details including visibility metrics, volume, difficulty, and associated monitor information." } }, { "name": "Create Prompt", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"prompt\": \"What is the best way to learn TypeScript?\",\n \"llmMonitorId\": \"uuid\",\n \"type\": \"ORGANIC\",\n \"languageCode\": \"en-US\",\n \"keywords\": [\"typescript\", \"learning\"],\n \"tags\": [\"programming\"],\n \"isActive\": true\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/prompts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts" ] }, "description": "Creates a new prompt for a monitor. You can optionally provide keywords, tags, and set the active status. The prompt type can be ORGANIC, BRAND_SPECIFIC, or COMPETITOR_COMPARISON." } }, { "name": "Update Prompt", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"BRAND_SPECIFIC\",\n \"intent\": \"INFORMATIONAL\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/prompts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Prompt UUID" } ] }, "description": "Updates a prompt's type and intent. Only type and intent fields can be updated. Intent can be BRANDED, INFORMATIONAL, NAVIGATIONAL, COMMERCIAL, or TRANSACTIONAL." } }, { "name": "Delete Prompt", "request": { "method": "DELETE", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/prompts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Prompt UUID" } ] }, "description": "Soft-deletes a prompt by ID. Returns 204 No Content on success." } }, { "name": "Bulk Create Prompts", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"llmMonitorId\": \"uuid\",\n \"prompts\": [\n {\n \"prompt\": \"What is TypeScript?\",\n \"type\": \"ORGANIC\",\n \"intent\": \"INFORMATIONAL\",\n \"languageCode\": \"en-US\"\n },\n {\n \"prompt\": \"How to use TypeScript?\",\n \"type\": \"ORGANIC\",\n \"languageCode\": \"en-US\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/prompts/bulk", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts", "bulk" ] }, "description": "Creates multiple prompts for a monitor in a single request. All prompts will be queued for execution automatically. Returns the count of created prompts and their IDs." } }, { "name": "Bulk Delete Prompts", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\"uuid1\", \"uuid2\", \"uuid3\"]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/prompts/bulk", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts", "bulk" ] }, "description": "Soft-deletes multiple prompts by their IDs. Returns the count of deleted prompts." } }, { "name": "Bulk Activate Prompts", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\"uuid1\", \"uuid2\", \"uuid3\"]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/prompts/bulk/activate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts", "bulk", "activate" ] }, "description": "Activates multiple prompts by setting their isActive status to true. Returns the count of activated prompts." } }, { "name": "Bulk Deactivate Prompts", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\"uuid1\", \"uuid2\", \"uuid3\"]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/prompts/bulk/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts", "bulk", "deactivate" ] }, "description": "Deactivates multiple prompts by setting their isActive status to false. Returns the count of deactivated prompts." } }, { "name": "Attach Tags to Prompt", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\"programming\", \"typescript\", \"tutorial\"]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/prompts/:id/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts", ":id", "tags" ], "variable": [ { "key": "id", "value": "", "description": "Prompt UUID" } ] }, "description": "Attaches tags to a prompt. Tags will be created if they don't exist. Returns the count of attached tags and the tag details." } }, { "name": "Bulk Attach Tags to Prompts", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"promptIds\": [\"uuid1\", \"uuid2\", \"uuid3\"],\n \"tags\": [\"programming\", \"typescript\"]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/prompts/bulk/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts", "bulk", "tags" ] }, "description": "Attaches tags to multiple prompts at once. Tags will be created if they don't exist. Returns the count of tag attachments created." } }, { "name": "Attach Topics to Prompt", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"topics\": [\"seo tips\", \"brand queries\", \"competitor analysis\"]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/prompts/:id/topics", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts", ":id", "topics" ], "variable": [ { "key": "id", "value": "", "description": "Prompt UUID" } ] }, "description": "Attaches topics to a prompt. Topics will be created if they don't exist. Returns the count of topic-prompt relationships created." } }, { "name": "Bulk Attach Topics to Prompts", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"promptIds\": [\"uuid1\", \"uuid2\", \"uuid3\"],\n \"topics\": [\"seo tips\", \"brand queries\"]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/prompts/bulk/topics", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "prompts", "bulk", "topics" ] }, "description": "Attaches topics to multiple prompts at once. Topics will be created if they don't exist. Returns the count of topic-prompt relationships created." } } ] }, { "name": "Query Fanouts", "description": "Query fanouts extracted from AI responses", "item": [ { "name": "Get Query Fanouts", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/query-fanouts?page=1&size=25&promptTypes=ORGANIC&intentTypes=INFORMATIONAL&sortBy=createdAt&sortOrder=desc", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "query-fanouts" ], "query": [ { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "25", "description": "Page size (default: 25, max: 100)", "disabled": true }, { "key": "query", "value": "", "description": "Text search on prompt", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true }, { "key": "intentTypes", "value": "INFORMATIONAL", "description": "Repeat for multiple: intentTypes=INFORMATIONAL&intentTypes=COMMERCIAL", "disabled": true }, { "key": "hasChatgptFanouts", "value": "", "description": "Filter to prompts with ChatGPT-extracted keywords", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter to single prompt by UUID", "disabled": true }, { "key": "promptIds", "value": "", "description": "Repeat for multiple: promptIds=uuid1&promptIds=uuid2", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "createdAt, updatedAt, type, or intent", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "asc or desc", "disabled": true } ] }, "description": "Returns paginated list of prompts with query fanouts extracted from AI responses. Each item includes combinedVolume, combinedDifficulty, and nested fanouts with the source response per fanout." } } ] }, { "name": "Tags", "description": "Tag management for prompts", "item": [ { "name": "Get Tags", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/tags?query=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ], "query": [ { "key": "query", "value": "", "description": "Search query to filter tags", "disabled": true } ] }, "description": "Returns all tags for the project with prompt counts. Optionally filter by search query. Each tag includes the number of prompts it's attached to." } }, { "name": "Create Tags", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"names\": [\"programming\", \"typescript\", \"tutorial\"]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags" ] }, "description": "Creates one or more tags for the project. If a tag with the same name already exists, it will be skipped. Returns the created tags with their IDs." } }, { "name": "Rename Tag", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"new-tag-name\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/tags/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Tag UUID" } ] }, "description": "Renames an existing tag. The new name must be unique within the project. Returns the updated tag." } }, { "name": "Delete Tag", "request": { "method": "DELETE", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/tags/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "tags", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Tag UUID" } ] }, "description": "Deletes a tag and removes it from all prompts. Returns 204 No Content on success." } } ] }, { "name": "Topics", "description": "Topic management for prompts", "item": [ { "name": "Get Topics", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/topics", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "topics" ] }, "description": "Returns all topics for the project with prompt counts. Each topic includes the number of prompts it is attached to." } }, { "name": "Create Topics", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"names\": [\"seo tips\", \"brand queries\", \"competitor analysis\"]\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/topics", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "topics" ] }, "description": "Creates one or more topics for the project. If a topic with the same name already exists it will be skipped. Returns the created topics with their IDs." } }, { "name": "Rename Topic", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"new-topic-name\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/topics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "topics", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Topic UUID" } ] }, "description": "Renames an existing topic. The new name must be unique within the project. Returns the updated topic id and name." } }, { "name": "Delete Topic", "request": { "method": "DELETE", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/topics/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "topics", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Topic UUID" } ] }, "description": "Deletes a topic and removes it from all prompts. Returns 204 No Content on success." } } ] }, { "name": "Personas", "description": "Persona configuration for monitors", "item": [ { "name": "Get Personas", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/personas", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "personas" ] }, "description": "Returns all personas for the project. Personas define user characteristics (age range, education level) used to configure monitors." } }, { "name": "Get Persona by ID", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/personas/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "personas", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Persona UUID" } ] }, "description": "Returns a specific persona by ID with full details including name, description, age range, and education level." } }, { "name": "Create Persona", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Tech Enthusiast\",\n \"description\": \"Tech-savvy user interested in programming\",\n \"ageRange\": \"25-35\",\n \"educationLevel\": \"Bachelor's Degree\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/personas", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "personas" ] }, "description": "Creates a new persona for the project. Personas can be associated with monitors to customize LLM responses. All fields are optional except name." } }, { "name": "Update Persona", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Persona Name\",\n \"description\": \"Updated description\",\n \"ageRange\": \"30-40\",\n \"educationLevel\": \"Master's Degree\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/personas/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "personas", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Persona UUID" } ] }, "description": "Updates an existing persona. All fields are optional - only include fields you want to update." } }, { "name": "Delete Persona", "request": { "method": "DELETE", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/personas/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "personas", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Persona UUID" } ] }, "description": "Deletes a persona. Returns 204 No Content on success." } } ] }, { "name": "Brands", "description": "Brand management for competitive analysis", "item": [ { "name": "Get Brands", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/brands?page=1&size=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "brands" ], "query": [ { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "50", "description": "Page size (default: 50)", "disabled": true }, { "key": "relation", "value": "", "description": "Filter by relation (OUR_BRAND, COMPETITOR, PARTNER, OTHER)", "disabled": true }, { "key": "query", "value": "", "description": "Search query", "disabled": true } ] }, "description": "Returns all brands for the project with pagination. Supports filtering by relation type and search query. Shows brands mentioned in LLM responses." } }, { "name": "Create Brand", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Competitor Brand\",\n \"url\": \"https://competitor.com\",\n \"relation\": \"COMPETITOR\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/brands", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "brands" ] }, "description": "Creates or connects a brand to the project. Relation can be OUR_BRAND, COMPETITOR, PARTNER, or OTHER. Returns the created brand with its relation." } }, { "name": "Update Brand", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"relation\": \"COMPETITOR\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/brands/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "brands", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Brand UUID" } ] }, "description": "Updates brand relationship. Only the relation field can be updated. Set relation to null to remove the relationship." } }, { "name": "Get Brands Visibility Over Time", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/brands/visibility-over-time?range=daily&limit=20", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "brands", "visibility-over-time" ], "query": [ { "key": "range", "value": "daily", "description": "Time range: daily, weekly, or monthly", "disabled": true }, { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "model", "value": "", "description": "Filter by model", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptTypes", "value": "", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true }, { "key": "limit", "value": "20", "description": "Limit number of brands (default: 20)", "disabled": true }, { "key": "excludeSelf", "value": "", "description": "Exclude own brand (true/false)", "disabled": true }, { "key": "relations", "value": "", "description": "Repeat for multiple: relations=DIRECT_COMPETITOR&relations=SELF", "disabled": true }, { "key": "query", "value": "", "description": "Search query", "disabled": true } ] }, "description": "Returns brand visibility over time for tracked brands. Shows how visibility scores change over time for your brand and competitors. Supports extensive filtering options." } } ] }, { "name": "Projects", "description": "Project management (organization-level keys only)", "item": [ { "name": "Get Projects", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v2/projects", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "projects" ] }, "description": "Returns all projects for the organization. Requires an organization-level API key. Each project includes ID, name, slug, website, and creation date." } }, { "name": "Create Project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"My New Project\",\n \"website\": \"https://example.com\",\n \"countryCode\": \"US\",\n \"languageCode\": \"en-US\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/projects", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "projects" ] }, "description": "Creates a new project in the organization. Requires an organization-level API key. Website scraping is skipped for API-created projects. Returns the created project with ID, name, slug, and website." } } ] }, { "name": "Actions", "description": "GEO action items (suggestions and tasks). List with filters; update status to accept, dismiss, or complete.", "item": [ { "name": "List Actions", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/actions?page=1&size=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "actions" ], "query": [ { "key": "status", "value": "suggested", "description": "Repeat for multiple: status=suggested&status=todo. Use status=dismissed with startDate for dismissed actions.", "disabled": true }, { "key": "type", "value": "SETUP", "description": "Repeat for multiple: type=SETUP&type=CONTENT_GAP. Values: WEBSITE_PERFORMANCE, WEBSITE_HEALTH, CONTENT_GAP, REDDIT_SOCIAL, SETUP, UNTRACKED_PAGE, UNTAPPED_PAGE, OFFSITE_MENTION", "disabled": true }, { "key": "severity", "value": "high", "description": "Repeat for multiple: severity=critical&severity=high. Values: critical, high, medium, low", "disabled": true }, { "key": "startDate", "value": "2026-06-01", "description": "YYYY-MM-DD (UTC). Only when status=dismissed; defaults to last 14 days if omitted.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "50", "description": "Page size (default: 50, max: 200)", "disabled": true } ] }, "description": "Returns paginated action items for the project. Defaults to non-dismissed actions. Each item includes type, status, severity, title, description, reasoning, geoImpact, and type-specific data." } }, { "name": "Update Action Status", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"todo\"\n}" }, "url": { "raw": "{{baseUrl}}/api/v2/actions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "actions", ":id" ], "variable": [ { "key": "id", "value": "{{actionId}}", "description": "Action item UUID from GET /api/v2/actions (or set actionId collection variable)" } ] }, "description": "Updates an action item status. Values: suggested, dismissed, todo, in_progress, done. completedAt and dismissedAt are set automatically by the server." } } ] }, { "name": "Sitemap", "description": "Sitemap crawl progress", "item": [ { "name": "Get Sitemap Progress", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": "{{baseUrl}}/api/v2/sitemap/progress", "description": "Returns sitemap crawl progress with totalUrls, crawledUrls, notCrawledUrls, progressPercentage, crawlHealthScore, httpStatusBreakdown (success/redirect/clientError/serverError/notCrawled), and crawlAttempts stats." } }, { "name": "List Sitemap URLs", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/sitemap/urls?page=1&size=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "sitemap", "urls" ], "query": [ { "key": "filter", "value": "errored", "description": "Optional: errored | redirected | inProgress. Omit to list all crawl-scope URLs.", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "50", "description": "Page size (default: 50, max: 100)", "disabled": true }, { "key": "sortBy", "value": "lastContentCrawledAt", "description": "Sort field (default: lastContentCrawledAt)", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "Sort order: asc | desc (default: desc)", "disabled": true }, { "key": "httpStatuses", "value": "403", "description": "When filter=errored: restrict to HTTP status codes (repeat param for multiple)", "disabled": true } ] }, "description": "Paginated list of sitemap URLs by crawl category. Use filter=errored for failed or blocked pages (HTTP errors, exhausted retries). Returns url, status, httpStatus, crawlAttempts, lastCrawledAt, and redirectsTo per item." } } ] }, { "name": "Site Health", "description": "Crawled pages with SEO issues (titles, meta descriptions, H1, thin content)", "item": [ { "name": "Get Site Health Pages", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/site-health?page=1&size=20", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "site-health" ], "query": [ { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "20", "description": "Page size (default: 20, max: 100)", "disabled": true }, { "key": "issueTypes", "value": "missingTitle", "description": "Repeat for multiple: issueTypes=missingTitle&issueTypes=noH1. Values: missingTitle, missingDescription, noH1, multipleH1, thinContent. Omit for all.", "disabled": true } ] }, "description": "Returns pages with SEO issues for the project website domain. Each page includes url, issue type, and crawledAt. Requires a configured project website." } } ] }, { "name": "Socials", "description": "Social media citations (Reddit posts and YouTube videos) found in LLM responses", "item": [ { "name": "List Reddit Citations", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/socials/reddit?page=1&size=25&sortBy=citationCount&sortOrder=desc", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "socials", "reddit" ], "query": [ { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "25", "description": "Page size (default: 25, max: 100)", "disabled": true }, { "key": "sortBy", "value": "citationCount", "description": "Sort field: citationCount | avgPosition | upvotes | numComments | publishedAt (default: citationCount)", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "Sort order: asc | desc (default: desc)", "disabled": true }, { "key": "from", "value": "2026-01-01T00:00:00.000Z", "description": "Filter citations from this date (ISO 8601)", "disabled": true }, { "key": "until", "value": "2026-12-31T23:59:59.999Z", "description": "Filter citations until this date (ISO 8601)", "disabled": true }, { "key": "models", "value": "openai_gpt-4o", "description": "Filter by LLM model ID. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple.", "disabled": true }, { "key": "tagIds", "value": "", "description": "Filter by tag UUID. Repeat for multiple.", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor UUID", "disabled": true }, { "key": "query", "value": "", "description": "Search within post title/content, author username, or subreddit name", "disabled": true }, { "key": "subredditName", "value": "", "description": "Filter to a specific subreddit (case-insensitive exact match, e.g. MachineLearning)", "disabled": true } ] }, "description": "Returns a paginated list of Reddit posts cited in LLM responses. Mirrors the Reddit table on the Socials dashboard. Supports sorting by citation count, average position, upvotes, comments, or publish date, plus filtering by date range, model, prompt type, tag, and subreddit." } }, { "name": "List YouTube Citations", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/socials/youtube?page=1&size=25&sortBy=citationCount&sortOrder=desc", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "socials", "youtube" ], "query": [ { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "25", "description": "Page size (default: 25, max: 100)", "disabled": true }, { "key": "sortBy", "value": "citationCount", "description": "Sort field: citationCount | avgPosition | viewCount | likeCount | commentCount | publishedAt (default: citationCount)", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "Sort order: asc | desc (default: desc)", "disabled": true }, { "key": "from", "value": "2026-01-01T00:00:00.000Z", "description": "Filter citations from this date (ISO 8601)", "disabled": true }, { "key": "until", "value": "2026-12-31T23:59:59.999Z", "description": "Filter citations until this date (ISO 8601)", "disabled": true }, { "key": "models", "value": "openai_gpt-4o", "description": "Filter by LLM model ID. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple.", "disabled": true }, { "key": "tagIds", "value": "", "description": "Filter by tag UUID. Repeat for multiple.", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor UUID", "disabled": true }, { "key": "query", "value": "", "description": "Search within video title/description or channel name", "disabled": true }, { "key": "channelName", "value": "", "description": "Filter to a specific YouTube channel (case-insensitive partial match on title/handle)", "disabled": true } ] }, "description": "Returns a paginated list of YouTube videos cited in LLM responses. Mirrors the YouTube table on the Socials dashboard. Supports sorting by citation count, average position, view count, likes, comments, or publish date, plus filtering by date range, model, prompt type, tag, and channel name." } } ] }, { "name": "Ads Radar", "description": "Sponsored ads captured in AI answers", "item": [ { "name": "List Ads", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/ads", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "ads" ], "query": [ { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "25", "description": "Page size (default: 25, max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search within ad title, description, advertiser name, or domain", "disabled": true }, { "key": "domains", "value": "", "description": "Filter by advertiser root domain. Repeat for multiple.", "disabled": true }, { "key": "promptIds", "value": "", "description": "Filter by prompt UUID. Repeat for multiple.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Sort field: createdAt | positionInResponse | advertiserName | rootDomain (default: createdAt)", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "Sort order: asc | desc (default: desc)", "disabled": true }, { "key": "from", "value": "2026-01-01T00:00:00.000Z", "description": "Filter from this date (ISO 8601)", "disabled": true }, { "key": "until", "value": "2026-12-31T23:59:59.999Z", "description": "Filter until this date (ISO 8601)", "disabled": true }, { "key": "models", "value": "openai_gpt-4o", "description": "Filter by LLM model ID. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple.", "disabled": true }, { "key": "intentTypes", "value": "COMMERCIAL", "description": "Filter by prompt intent: BRANDED | INFORMATIONAL | NAVIGATIONAL | COMMERCIAL | TRANSACTIONAL. Repeat for multiple.", "disabled": true } ] }, "description": "Returns a paginated list of sponsored ads captured in AI answers, with ad creative, advertiser, landing page, and source response. Requires the Ads Radar plan feature." }, "response": [] }, { "name": "List Prompts With Ads", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/ads/prompts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "ads", "prompts" ], "query": [ { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "25", "description": "Page size (default: 25, max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search within prompt text", "disabled": true }, { "key": "domains", "value": "", "description": "Filter by advertiser root domain. Repeat for multiple.", "disabled": true }, { "key": "from", "value": "2026-01-01T00:00:00.000Z", "description": "Filter from this date (ISO 8601)", "disabled": true }, { "key": "until", "value": "2026-12-31T23:59:59.999Z", "description": "Filter until this date (ISO 8601)", "disabled": true }, { "key": "models", "value": "openai_gpt-4o", "description": "Filter by LLM model ID. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple.", "disabled": true }, { "key": "intentTypes", "value": "COMMERCIAL", "description": "Filter by prompt intent: BRANDED | INFORMATIONAL | NAVIGATIONAL | COMMERCIAL | TRANSACTIONAL. Repeat for multiple.", "disabled": true } ] }, "description": "Returns a paginated list of prompts whose AI answers contained sponsored ads, with per-prompt ad counts. Requires the Ads Radar plan feature." }, "response": [] }, { "name": "List Ad Domains", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/ads/domains", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "ads", "domains" ], "query": [ { "key": "from", "value": "2026-01-01T00:00:00.000Z", "description": "Filter from this date (ISO 8601)", "disabled": true }, { "key": "until", "value": "2026-12-31T23:59:59.999Z", "description": "Filter until this date (ISO 8601)", "disabled": true }, { "key": "models", "value": "openai_gpt-4o", "description": "Filter by LLM model ID. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple.", "disabled": true }, { "key": "intentTypes", "value": "COMMERCIAL", "description": "Filter by prompt intent: BRANDED | INFORMATIONAL | NAVIGATIONAL | COMMERCIAL | TRANSACTIONAL. Repeat for multiple.", "disabled": true } ] }, "description": "Returns advertiser root domains seen in captured ads, ordered by ad count. Requires the Ads Radar plan feature." }, "response": [] }, { "name": "Ad Domain Analytics", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/ads/domain-analytics", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "ads", "domain-analytics" ], "query": [ { "key": "domains", "value": "", "description": "Filter by advertiser root domain. Repeat for multiple.", "disabled": true }, { "key": "from", "value": "2026-01-01T00:00:00.000Z", "description": "Filter from this date (ISO 8601)", "disabled": true }, { "key": "until", "value": "2026-12-31T23:59:59.999Z", "description": "Filter until this date (ISO 8601)", "disabled": true }, { "key": "models", "value": "openai_gpt-4o", "description": "Filter by LLM model ID. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple.", "disabled": true }, { "key": "intentTypes", "value": "COMMERCIAL", "description": "Filter by prompt intent: BRANDED | INFORMATIONAL | NAVIGATIONAL | COMMERCIAL | TRANSACTIONAL. Repeat for multiple.", "disabled": true } ] }, "description": "Returns the top advertiser domains with daily ad counts. Defaults to the last 90 days when dates are omitted. Requires the Ads Radar plan feature." }, "response": [] } ] }, { "name": "Shopping", "description": "Product appearances in AI shopping answers and tracked products", "item": [ { "name": "List Shopping Product Appearances", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/shopping/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "shopping", "items" ], "query": [ { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "25", "description": "Page size (default: 25, max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search within product title or merchants", "disabled": true }, { "key": "foreignId", "value": "", "description": "Exact (case-insensitive) product ID in the source answer engine", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Sort field: createdAt | positionInResponse | rating | numReviews (default: createdAt)", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "Sort order: asc | desc (default: desc)", "disabled": true }, { "key": "from", "value": "2026-01-01T00:00:00.000Z", "description": "Filter from this date (ISO 8601)", "disabled": true }, { "key": "until", "value": "2026-12-31T23:59:59.999Z", "description": "Filter until this date (ISO 8601)", "disabled": true }, { "key": "models", "value": "openai_gpt-4o", "description": "Filter by LLM model ID. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple.", "disabled": true }, { "key": "intentTypes", "value": "COMMERCIAL", "description": "Filter by prompt intent: BRANDED | INFORMATIONAL | NAVIGATIONAL | COMMERCIAL | TRANSACTIONAL. Repeat for multiple.", "disabled": true } ] }, "description": "Returns a paginated list of product appearances captured in AI shopping answers, with price stats, merchant, position, and source response. Requires the Shopping insights plan feature." }, "response": [] }, { "name": "Get Shopping Product", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/shopping/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "shopping", "items", ":id" ], "variable": [ { "key": "id", "value": "{{shoppingItemId}}", "description": "Shopping product UUID" } ] }, "description": "Returns one extracted shopping product with appearance stats and its latest appearance. Requires the Shopping insights plan feature." }, "response": [] }, { "name": "Shopping Products Over Time", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/shopping/products-over-time", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "shopping", "products-over-time" ], "query": [ { "key": "from", "value": "2026-01-01T00:00:00.000Z", "description": "Filter from this date (ISO 8601)", "disabled": true }, { "key": "until", "value": "2026-12-31T23:59:59.999Z", "description": "Filter until this date (ISO 8601)", "disabled": true }, { "key": "models", "value": "openai_gpt-4o", "description": "Filter by LLM model ID. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple.", "disabled": true }, { "key": "intentTypes", "value": "COMMERCIAL", "description": "Filter by prompt intent: BRANDED | INFORMATIONAL | NAVIGATIONAL | COMMERCIAL | TRANSACTIONAL. Repeat for multiple.", "disabled": true } ] }, "description": "Returns the daily count of product appearances. Defaults to the last 90 days when dates are omitted. Requires the Shopping insights plan feature." }, "response": [] }, { "name": "Shopping Product Position Analytics", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/shopping/product-position-analytics", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "shopping", "product-position-analytics" ], "query": [ { "key": "limit", "value": "8", "description": "Maximum entries to return (default: 8, max: 20)", "disabled": true }, { "key": "from", "value": "2026-01-01T00:00:00.000Z", "description": "Filter from this date (ISO 8601)", "disabled": true }, { "key": "until", "value": "2026-12-31T23:59:59.999Z", "description": "Filter until this date (ISO 8601)", "disabled": true }, { "key": "models", "value": "openai_gpt-4o", "description": "Filter by LLM model ID. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple.", "disabled": true }, { "key": "intentTypes", "value": "COMMERCIAL", "description": "Filter by prompt intent: BRANDED | INFORMATIONAL | NAVIGATIONAL | COMMERCIAL | TRANSACTIONAL. Repeat for multiple.", "disabled": true } ] }, "description": "Returns the top products by appearances with daily average 1-based positions. Defaults to the last 90 days when dates are omitted. Requires the Shopping insights plan feature." }, "response": [] }, { "name": "Shopping Top Merchant Domains", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/shopping/top-merchant-domains", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "shopping", "top-merchant-domains" ], "query": [ { "key": "limit", "value": "8", "description": "Maximum entries to return (default: 8, max: 20)", "disabled": true }, { "key": "from", "value": "2026-01-01T00:00:00.000Z", "description": "Filter from this date (ISO 8601)", "disabled": true }, { "key": "until", "value": "2026-12-31T23:59:59.999Z", "description": "Filter until this date (ISO 8601)", "disabled": true }, { "key": "models", "value": "openai_gpt-4o", "description": "Filter by LLM model ID. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple.", "disabled": true }, { "key": "intentTypes", "value": "COMMERCIAL", "description": "Filter by prompt intent: BRANDED | INFORMATIONAL | NAVIGATIONAL | COMMERCIAL | TRANSACTIONAL. Repeat for multiple.", "disabled": true } ] }, "description": "Returns merchant domains ordered by product appearances. Requires the Shopping insights plan feature." }, "response": [] }, { "name": "Shopping Top Products", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/shopping/top-products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "shopping", "top-products" ], "query": [ { "key": "limit", "value": "8", "description": "Maximum entries to return (default: 8, max: 20)", "disabled": true }, { "key": "from", "value": "2026-01-01T00:00:00.000Z", "description": "Filter from this date (ISO 8601)", "disabled": true }, { "key": "until", "value": "2026-12-31T23:59:59.999Z", "description": "Filter until this date (ISO 8601)", "disabled": true }, { "key": "models", "value": "openai_gpt-4o", "description": "Filter by LLM model ID. Repeat for multiple: models=x&models=y", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple.", "disabled": true }, { "key": "intentTypes", "value": "COMMERCIAL", "description": "Filter by prompt intent: BRANDED | INFORMATIONAL | NAVIGATIONAL | COMMERCIAL | TRANSACTIONAL. Repeat for multiple.", "disabled": true } ] }, "description": "Returns products ordered by appearances. Requires the Shopping insights plan feature." }, "response": [] }, { "name": "List Tracked Products", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/shopping/tracked-products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "shopping", "tracked-products" ], "query": [ { "key": "search", "value": "", "description": "Case-insensitive search within name and description", "disabled": true }, { "key": "externalProductId", "value": "", "description": "Exact (case-insensitive) catalog product ID", "disabled": true }, { "key": "matchStatus", "value": "matched", "description": "Filter by match status: matched | unmatched", "disabled": true } ] }, "description": "Returns tracked products (My products) with their matched extracted shopping items, newest first. Requires the Shopping insights plan feature." }, "response": [] }, { "name": "Add Tracked Products", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/shopping/tracked-products", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "shopping", "tracked-products" ] }, "body": { "mode": "raw", "raw": "{\n \"products\": [\n {\n \"externalProductId\": \"sku-123\",\n \"name\": \"My Product\",\n \"description\": \"Optional description\"\n }\n ]\n}" }, "description": "Tracks one or more products by catalog ID; duplicates are counted and skipped instead of failing the request. Requires the Shopping insights plan feature." }, "response": [] }, { "name": "Update Tracked Product", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/shopping/tracked-products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "shopping", "tracked-products", ":id" ], "variable": [ { "key": "id", "value": "{{trackedProductId}}", "description": "Tracked product UUID" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Renamed Product\",\n \"description\": \"Optional description\"\n}" }, "description": "Updates the name or description of a tracked product; the catalog ID is immutable. Requires the Shopping insights plan feature." }, "response": [] }, { "name": "Delete Tracked Product", "request": { "method": "DELETE", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/shopping/tracked-products/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "shopping", "tracked-products", ":id" ], "variable": [ { "key": "id", "value": "{{trackedProductId}}", "description": "Tracked product UUID" } ] }, "description": "Stops tracking a product; extracted shopping data is unaffected. Requires the Shopping insights plan feature." }, "response": [] } ] }, { "name": "Analytics", "description": "Analytics data and insights", "item": [ { "name": "Get Sentiment Time Series", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/sentiment-time-series?range=day&startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "sentiment-time-series" ], "query": [ { "key": "range", "value": "day", "description": "Time range: day, week, or month", "disabled": true }, { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "model", "value": "", "description": "Filter by model", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "promptTypes", "value": "", "description": "Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true } ] }, "description": "Returns brand sentiment time series data. Shows how sentiment towards your brand changes over time across different LLM models. Supports filtering by model, monitor, prompt, or prompt types." } }, { "name": "Get Visitors Total", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/visitors/total?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "visitors", "total" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "timezone", "value": "", "description": "Timezone (e.g., America/New_York)", "disabled": true }, { "key": "pathname", "value": "", "description": "Filter by pathname", "disabled": true } ] }, "description": "Returns total visitor counts over time. Date range limited to 60 days. Granularity is automatically adjusted (minute for 24h periods, day for longer periods)." } }, { "name": "Get Visitors Trend", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/visitors/trend?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "visitors", "trend" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "timezone", "value": "", "description": "Timezone (e.g., America/New_York)", "disabled": true }, { "key": "referrerDomains", "value": "", "description": "Repeat for multiple: referrerDomains=chatgpt.com&referrerDomains=claude.ai", "disabled": true } ] }, "description": "Returns visitor trends grouped by referrer. Date range limited to 60 days. Use referrerDomains=chatgpt.com&referrerDomains=claude.ai for multiple." } }, { "name": "Get Referrer Stats", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/visitors/referrer-stats?startDate=&endDate=&referrerDomains=chatgpt.com&referrerDomains=claude.ai&timezone=&path=&pathMatch=partial&location=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "visitors", "referrer-stats" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "referrerDomains", "value": "chatgpt.com", "description": "Required. Add multiple for comparison. Allowed: chatgpt.com, claude.ai, perplexity.ai, gemini.google.com, copilot.microsoft.com", "disabled": false }, { "key": "referrerDomains", "value": "claude.ai", "description": "Second domain for comparison", "disabled": false }, { "key": "timezone", "value": "", "description": "IANA timezone (e.g., America/New_York)", "disabled": true }, { "key": "path", "value": "", "description": "Filter by page path", "disabled": true }, { "key": "pathMatch", "value": "partial", "description": "exact or partial", "disabled": true }, { "key": "location", "value": "", "description": "Country code (e.g., US, GB)", "disabled": true } ] }, "description": "Returns referrer comparison stats with period-over-period changes. Date range limited to 60 days. referrerDomains required - repeat for multiple: referrerDomains=chatgpt.com&referrerDomains=claude.ai" } }, { "name": "Get Top Browsers", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/visitors/top-browsers?startDate=&endDate=&timezone=&path=&pathMatch=partial&location=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "visitors", "top-browsers" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "timezone", "value": "", "description": "IANA timezone", "disabled": true }, { "key": "path", "value": "", "description": "Filter by page path", "disabled": true }, { "key": "pathMatch", "value": "partial", "description": "exact or partial", "disabled": true }, { "key": "location", "value": "", "description": "Country code", "disabled": true } ] }, "description": "Returns top browsers by visit count. Date range limited to 60 days." } }, { "name": "Get Top Devices", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/visitors/top-devices?startDate=&endDate=&timezone=&path=&pathMatch=partial&location=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "visitors", "top-devices" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "timezone", "value": "", "description": "IANA timezone", "disabled": true }, { "key": "path", "value": "", "description": "Filter by page path", "disabled": true }, { "key": "pathMatch", "value": "partial", "description": "exact or partial", "disabled": true }, { "key": "location", "value": "", "description": "Country code", "disabled": true } ] }, "description": "Returns top devices by visit count. Date range limited to 60 days." } }, { "name": "Get Top Locations", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/visitors/top-locations?startDate=&endDate=&timezone=&path=&pathMatch=partial&location=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "visitors", "top-locations" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "timezone", "value": "", "description": "IANA timezone", "disabled": true }, { "key": "path", "value": "", "description": "Filter by page path", "disabled": true }, { "key": "pathMatch", "value": "partial", "description": "exact or partial", "disabled": true }, { "key": "location", "value": "", "description": "Country code", "disabled": true } ] }, "description": "Returns top geographic locations by visit count. Date range limited to 60 days." } }, { "name": "Get Top Pages", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/visitors/top-pages?startDate=&endDate=&timezone=&path=&pathMatch=partial&location=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "visitors", "top-pages" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "timezone", "value": "", "description": "IANA timezone", "disabled": true }, { "key": "path", "value": "", "description": "Filter by page path", "disabled": true }, { "key": "pathMatch", "value": "partial", "description": "exact or partial", "disabled": true }, { "key": "location", "value": "", "description": "Country code", "disabled": true } ] }, "description": "Returns top pages by visit count. Date range limited to 60 days." } }, { "name": "Get Top Sources", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/visitors/top-sources?startDate=&endDate=&timezone=&path=&pathMatch=partial&location=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "visitors", "top-sources" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "timezone", "value": "", "description": "IANA timezone", "disabled": true }, { "key": "path", "value": "", "description": "Filter by page path", "disabled": true }, { "key": "pathMatch", "value": "partial", "description": "exact or partial", "disabled": true }, { "key": "location", "value": "", "description": "Country code", "disabled": true } ] }, "description": "Returns top AI referrer sources by visit count. Date range limited to 60 days." } }, { "name": "Get Crawlers Trend", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/crawlers/trend?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "crawlers", "trend" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "timezone", "value": "", "description": "Timezone (e.g., America/New_York)", "disabled": true }, { "key": "crawlers", "value": "", "description": "Repeat for multiple: crawlers=Googlebot&crawlers=Bingbot", "disabled": true } ] }, "description": "Returns crawler activity trends over time. Shows crawler requests grouped by crawler type (Googlebot, Bingbot, etc.) over time. Granularity is automatically adjusted." } }, { "name": "Get Crawlers Top Pages", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/crawlers/top-pages?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "crawlers", "top-pages" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "crawlers", "value": "", "description": "Repeat for multiple: crawlers=Googlebot&crawlers=Bingbot", "disabled": true } ] }, "description": "Returns top pages requested by crawlers. Shows which pages are crawled most frequently, helping identify which content search engines are indexing." } }, { "name": "Get Crawler Events", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/analytics/crawlers/events?startDate=&endDate=&page=1&size=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "analytics", "crawlers", "events" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "page", "value": "1", "description": "Page number (1-based, default 1)", "disabled": true }, { "key": "size", "value": "50", "description": "Page size (max 200, default 50)", "disabled": true }, { "key": "timezone", "value": "", "description": "IANA timezone (optional)", "disabled": true }, { "key": "crawlers", "value": "", "description": "AI crawler key (repeat param for multiple, e.g. openai-gptbot)", "disabled": true }, { "key": "path", "value": "", "description": "Filter by request path", "disabled": true }, { "key": "pathMatch", "value": "partial", "description": "exact or partial", "disabled": true }, { "key": "statusCodes", "value": "", "description": "HTTP status code filter (repeat param for multiple)", "disabled": true } ] }, "description": "Paginated log of individual AI crawler HTTP requests for the project (same data as the in-product crawler activity explorer). See API docs / OpenAPI for response and error schemas." } } ] }, { "name": "Responses", "description": "Response analytics including mentions, competitors, and sentiment", "item": [ { "name": "Get Responses", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/responses?page=1&size=10&sortBy=createdAt&sortOrder=desc", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "responses" ], "query": [ { "key": "page", "value": "1", "description": "Page number (default: 1)", "disabled": true }, { "key": "size", "value": "10", "description": "Page size (default: 10)", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true }, { "key": "promptId", "value": "", "description": "Filter by prompt ID", "disabled": true }, { "key": "query", "value": "", "description": "Search query", "disabled": true }, { "key": "model", "value": "", "description": "Filter by model", "disabled": true }, { "key": "sentiment", "value": "", "description": "Filter by sentiment (POSITIVE, NEGATIVE, NEUTRAL)", "disabled": true }, { "key": "mentionedOurBrand", "value": "", "description": "Filter by brand mention (true/false)", "disabled": true }, { "key": "promptTypes", "value": "ORGANIC", "description": "Filter by prompt type: ORGANIC | BRAND_SPECIFIC | COMPETITOR_COMPARISON. Repeat for multiple: promptTypes=ORGANIC&promptTypes=BRAND_SPECIFIC", "disabled": true }, { "key": "from", "value": "", "description": "Filter from date (ISO 8601)", "disabled": true }, { "key": "until", "value": "", "description": "Filter until date (ISO 8601)", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Sort field (default: createdAt)", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "Sort order (asc/desc)", "disabled": true } ] }, "description": "Returns paginated list of LLM responses with search and filtering options. Each response includes brandMentions (per-brand visibility, sentiment, relation), citations (url, domain, title, sourceType, contentType), visibility scores, sentiment, competitor mentions, and citationCount. Supports filtering by monitor, prompt, model, sentiment, brand mentions, and date range." } }, { "name": "Get Response by ID", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/responses/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "responses", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Response UUID" } ] }, "description": "Returns a single response by ID with full details including brandMentions, content, visibility score, sentiment, competitor mentions, and citations (url, domain, title, sourceType, contentType, rank)." } }, { "name": "Get Responses Summary", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/responses/summary?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "responses", "summary" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true } ] }, "description": "Returns response summary including total responses, total brand mentions, and brand mention rate (percentage) within the specified date range." } }, { "name": "Get Responses Mentions Time Series", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/responses/mentions-time-series?range=day&startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "responses", "mentions-time-series" ], "query": [ { "key": "range", "value": "day", "description": "Time range: day, week, or month", "disabled": true }, { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true }, { "key": "llmMonitorId", "value": "", "description": "Filter by monitor ID", "disabled": true } ] }, "description": "Returns brand and competitor mentions over time. Shows daily, weekly, or monthly aggregated data with brand mentions and competitor mentions counts per time period." } }, { "name": "Get Responses Competitors", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/responses/competitors?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "responses", "competitors" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true } ] }, "description": "Returns top competitor mentions from LLM responses. Lists competitors sorted by mention frequency within the specified date range." } }, { "name": "Get Responses Sentiment Distribution", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/responses/sentiment-distribution?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "responses", "sentiment-distribution" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true } ] }, "description": "Returns sentiment distribution of LLM responses. Shows counts for POSITIVE, NEGATIVE, and NEUTRAL sentiments within the specified date range." } }, { "name": "Get Responses Sentiment Time Series", "request": { "method": "GET", "header": [ { "key": "X-Project-Id", "value": "{{projectId}}", "type": "text", "disabled": false, "description": "Required when using organization-level API keys. Set projectId variable." } ], "url": { "raw": "{{baseUrl}}/api/v2/responses/sentiment-time-series?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "responses", "sentiment-time-series" ], "query": [ { "key": "startDate", "value": "", "description": "Start date (YYYY-MM-DD)", "disabled": true }, { "key": "endDate", "value": "", "description": "End date (YYYY-MM-DD)", "disabled": true } ] }, "description": "Returns sentiment changes over time for brand mentions. Shows how sentiment towards your brand evolves across responses within the specified date range." } } ] } ] } ] }