{ "item": [ { "name": "me", "description": "", "item": [ { "id": "7f5bf37f-355a-45f8-b66c-9ebe9e8416b1", "name": "Verify token and retrieve client identity", "request": { "name": "Verify token and retrieve client identity", "description": { "content": "Returns the identity associated with your Bearer token. Use this as a quick connectivity and auth check.\n\nUnlike all other endpoints, the response is a **bare object** - there is no `data` wrapper.\n`agency_id` is `null` for super-admin tokens that have access across all agencies.\n`abilities: [\"*\"]` indicates full read access to all resources.\n", "type": "text/plain" }, "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4bfa87eb-17ef-417c-bf60-1e6596eed045", "name": "Token is valid. Returns the associated client identity.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"agency_id\": \"\",\n \"status\": \"active\",\n \"abilities\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ea328f9-1438-485e-b5b6-63ccbc2cd650", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "projects", "description": "", "item": [ { "id": "1f3ab5e2-8093-4727-99e3-ea7716be060a", "name": "List all projects accessible to your token", "request": { "name": "List all projects accessible to your token", "description": { "content": "Returns a paginated list of SEO projects accessible to your token.\n\nResults are cached for up to 1 hour. The `cache_refreshed_at` field shows when the cache was last populated.\n\nUse `status` and `search` to narrow results. The `agency_id` filter is available to super-admin tokens only.\nResults are returned 100 per page; use `?page=N` to paginate.\n", "type": "text/plain" }, "url": { "path": [ "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by project lifecycle status.", "type": "text/plain" }, "key": "status", "value": "active" }, { "disabled": false, "description": { "content": "Partial match against project name or domain.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by agency ID. Super-admin tokens only.", "type": "text/plain" }, "key": "agency_id", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page. Maximum 100.", "type": "text/plain" }, "key": "per_page", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "24185ca1-0a32-4e89-bbd0-db3c3635e035", "name": "Paginated list of projects.", "originalRequest": { "url": { "path": [ "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by project lifecycle status.", "type": "text/plain" }, "key": "status", "value": "active" }, { "disabled": false, "description": { "content": "Partial match against project name or domain.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by agency ID. Super-admin tokens only.", "type": "text/plain" }, "key": "agency_id", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page. Maximum 100.", "type": "text/plain" }, "key": "per_page", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"ended\",\n \"keyword_count\": \"\",\n \"latest_report_generated_at\": \"\",\n \"latest_report_id\": \"\",\n \"latest_report_number\": \"\",\n \"latest_report_status\": \"pending\",\n \"links\": {\n \"latest_report\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"paused\",\n \"keyword_count\": \"\",\n \"latest_report_generated_at\": \"\",\n \"latest_report_id\": \"\",\n \"latest_report_number\": \"\",\n \"latest_report_status\": \"failed\",\n \"links\": {\n \"latest_report\": \"\"\n }\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"per_page\": \"\",\n \"total\": \"\",\n \"last_page\": \"\",\n \"from\": \"\",\n \"to\": \"\"\n },\n \"links\": {\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"cache_refreshed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b53c3d3-e6ce-4125-a0c8-8949394b3786", "name": "Bad request - unknown parameter, out-of-range value, or invalid input.", "originalRequest": { "url": { "path": [ "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by project lifecycle status.", "type": "text/plain" }, "key": "status", "value": "active" }, { "disabled": false, "description": { "content": "Partial match against project name or domain.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by agency ID. Super-admin tokens only.", "type": "text/plain" }, "key": "agency_id", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page. Maximum 100.", "type": "text/plain" }, "key": "per_page", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6e45315-c603-4e47-8b51-01ecd07cae27", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by project lifecycle status.", "type": "text/plain" }, "key": "status", "value": "active" }, { "disabled": false, "description": { "content": "Partial match against project name or domain.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by agency ID. Super-admin tokens only.", "type": "text/plain" }, "key": "agency_id", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page. Maximum 100.", "type": "text/plain" }, "key": "per_page", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaff283b-ba88-4871-9da6-f10794d50172", "name": "Token is valid but access is denied (wrong agency or non-whitelisted IP).", "originalRequest": { "url": { "path": [ "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by project lifecycle status.", "type": "text/plain" }, "key": "status", "value": "active" }, { "disabled": false, "description": { "content": "Partial match against project name or domain.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Filter by agency ID. Super-admin tokens only.", "type": "text/plain" }, "key": "agency_id", "value": "" }, { "disabled": false, "description": { "content": "Page number (1-based).", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Number of results per page. Maximum 100.", "type": "text/plain" }, "key": "per_page", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{project}", "description": "", "item": [ { "id": "a2137e38-11ad-44fc-8bc5-69a6a25f53e3", "name": "Full metadata for a single project", "request": { "name": "Full metadata for a single project", "description": { "content": "Returns extended project metadata beyond what the list endpoint provides, including assigned users,\nlanguage settings, email configuration, and agency/plan information.\n\n**Note:** `project.agency` is a plain string (the agency name), unlike the `agency` field inside user\nobjects which is `{ id, name }`.\n", "type": "text/plain" }, "url": { "path": [ "projects", ":project" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "project", "disabled": false, "description": { "content": "(Required) Project ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9653110d-3153-4a80-bf87-4851cad11a37", "name": "Full project metadata.", "originalRequest": { "url": { "path": [ "projects", ":project" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"termination pending\",\n \"keyword_count\": \"\",\n \"latest_report_generated_at\": \"\",\n \"latest_report_id\": \"\",\n \"latest_report_number\": \"\",\n \"latest_report_status\": \"running\",\n \"links\": {\n \"latest_report\": \"\"\n },\n \"company_name\": \"\",\n \"domain\": \"\",\n \"created_at\": \"\",\n \"country\": {\n \"id\": \"\",\n \"label\": \"\"\n },\n \"text_language\": {\n \"id\": \"\",\n \"label\": \"\"\n },\n \"report_language\": {\n \"id\": \"\",\n \"label\": \"\"\n },\n \"managing_user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"created_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"contact_email\": \"\",\n \"client_emails\": [\n \"\",\n \"\"\n ],\n \"cc_email\": \"\",\n \"receives_monthly_reports\": \"\",\n \"agency\": \"\",\n \"plan\": \"\",\n \"gsc_status\": \"\"\n },\n \"cache_refreshed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "300b5a76-2959-4999-b15d-8c86de928d1b", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "projects", ":project" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc14e2df-0468-4ea9-a975-21a684e98a56", "name": "Token is valid but access is denied (wrong agency or non-whitelisted IP).", "originalRequest": { "url": { "path": [ "projects", ":project" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3e5015b-a707-497a-9eea-eb66834b2b87", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "projects", ":project" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "reports", "description": "", "item": [ { "id": "0e446b89-e5fd-41f0-bf4f-3ef8a77f8be1", "name": "All reports for a project, newest first", "request": { "name": "All reports for a project, newest first", "description": { "content": "Returns all reports for a project sorted newest first. A project can have up to 26 reports,\none for each position in the content delivery sequence.\n\nOnly fetch content (via the content endpoint) for reports where `status === \"completed\"`.\nUse `report_number` as a stable sync key - it identifies the report's position in the sequence\nand never changes, unlike the database `id`.\n", "type": "text/plain" }, "url": { "path": [ "projects", ":project", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "project", "disabled": false, "description": { "content": "(Required) Project ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b6b24fee-3ac1-45e5-8617-7b45aaf8dfff", "name": "List of reports for the project, newest first.", "originalRequest": { "url": { "path": [ "projects", ":project", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"project_id\": \"\",\n \"report_number\": \"\",\n \"report_name\": \"\",\n \"status\": \"pending\",\n \"date_to_create_texts\": \"\",\n \"date_to_send_to_client\": \"\",\n \"sent\": \"\",\n \"approved_status\": \"waiting\",\n \"approved_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"managed_status\": \"in-progress\",\n \"managed_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"pdf_link\": \"\",\n \"web_link\": \"\"\n },\n {\n \"id\": \"\",\n \"project_id\": \"\",\n \"report_number\": \"\",\n \"report_name\": \"\",\n \"status\": \"completed\",\n \"date_to_create_texts\": \"\",\n \"date_to_send_to_client\": \"\",\n \"sent\": \"\",\n \"approved_status\": \"approved\",\n \"approved_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"managed_status\": \"waiting-on-client\",\n \"managed_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"pdf_link\": \"\",\n \"web_link\": \"\"\n }\n ],\n \"cache_refreshed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c4f1590-85f1-4d4c-9043-d4e9e03ec85d", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "projects", ":project", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df4901b2-a31a-427a-bfde-7b3238eca366", "name": "Token is valid but access is denied (wrong agency or non-whitelisted IP).", "originalRequest": { "url": { "path": [ "projects", ":project", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39132708-dfca-41dc-a60c-39e57e5d1c33", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "projects", ":project", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "latest", "description": "", "item": [ { "id": "dc10eb72-e3c2-4ca6-afa5-630fc9924c8e", "name": "The most recently created report", "request": { "name": "The most recently created report", "description": { "content": "Returns the most recently created report for a project. Returns `404` if the project has no reports yet.\n\nThis is the recommended polling endpoint to detect new reports: compare the returned `report_number`\nwith the last value you stored. If it's higher, a new report is available and you can fetch its content.\n\nAlways check `status === \"completed\"` before calling the content endpoint.\n", "type": "text/plain" }, "url": { "path": [ "projects", ":project", "reports", "latest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "project", "disabled": false, "description": { "content": "(Required) Project ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9e869f70-b89b-47a1-9317-ff8437543073", "name": "Most recent report for the project.", "originalRequest": { "url": { "path": [ "projects", ":project", "reports", "latest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"project_id\": \"\",\n \"report_number\": \"\",\n \"report_name\": \"\",\n \"status\": \"pending\",\n \"date_to_create_texts\": \"\",\n \"date_to_send_to_client\": \"\",\n \"sent\": \"\",\n \"approved_status\": \"approved\",\n \"approved_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"managed_status\": \"waiting-on-client\",\n \"managed_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"pdf_link\": \"\",\n \"web_link\": \"\"\n },\n \"cache_refreshed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7045ffb-7e61-47c8-9268-ee315c32f053", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "projects", ":project", "reports", "latest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e3e3050-07c3-4349-a81a-8177f7936a42", "name": "Token is valid but access is denied (wrong agency or non-whitelisted IP).", "originalRequest": { "url": { "path": [ "projects", ":project", "reports", "latest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0355cf28-9874-48c2-8a29-3340d19227b5", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "projects", ":project", "reports", "latest" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{report_number}", "description": "", "item": [ { "name": "content", "description": "", "item": [ { "id": "237f65a6-a10b-4c7c-8497-64eb61d5d77d", "name": "Full generated SEO content for a report, grouped by keyword", "request": { "name": "Full generated SEO content for a report, grouped by keyword", "description": { "content": "The primary integration endpoint. Returns AI-generated SEO content for every keyword tracked in a project,\nfor the specified report position.\n\n**`report_number`** is the report's position in the delivery sequence (1-26), **not** its database `id`.\nUse the `report_number` from the reports endpoints to construct this path.\n\n**Content shape** varies by `content_scheme`:\n- Array schemes (`metadata`, `h1_headlines`, `h2_text_blocks`, `h3_text_blocks`, `h4_text_blocks`, `qa_block`, `link_blocks`) -\n `content` and `html` are arrays of variant objects; pick the variant that fits best.\n- Object schemes (`single_text_block`, `h2_summary_block`, `subnavigation`, `bullet_points`, `numbered_points`, `image_alt_text`) -\n `content` and `html` are single objects.\n\n`content_scheme_fields` lists the field names present in each content block for this report.\nKeywords without generated content have `has_content: false` and `content: null`.\n\nReturns `400` if `report_number` is outside the valid range (1-26).\nReturns `404` if no report exists at that position for the project.\n", "type": "text/plain" }, "url": { "path": [ "projects", ":project", "reports", ":report_number", "content" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "project", "disabled": false, "description": { "content": "(Required) Project ID.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "report_number", "disabled": false, "description": { "content": "(Required) Report's position in the project's delivery sequence (1-26). Not the report database ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2a2b0682-b70d-4b40-9b29-605def91a9ca", "name": "Generated SEO content for all keywords in the report.", "originalRequest": { "url": { "path": [ "projects", ":project", "reports", ":report_number", "content" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"report_number\": \"\",\n \"report_id\": \"\",\n \"report_name\": \"\",\n \"content_scheme\": \"bullet_points\",\n \"content_scheme_fields\": [\n \"\",\n \"\"\n ],\n \"links\": {\n \"project_website\": \"\",\n \"report_web\": \"\",\n \"report_pdf\": \"\"\n },\n \"project_id\": \"\",\n \"project_domain\": \"\",\n \"project_status\": \"termination pending\",\n \"is_generated\": \"\",\n \"generation_status\": \"pending\",\n \"approved_status\": \"blocked\",\n \"approved_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"managed_status\": \"on-hold\",\n \"managed_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n \"date_to_create_texts\": \"\",\n \"date_to_send_to_client\": \"\",\n \"summary\": {\n \"keyword_count\": \"\",\n \"keywords_with_content\": \"\"\n },\n \"keywords\": [\n {\n \"keyword_id\": \"\",\n \"keyword\": \"\",\n \"keyword_url\": \"\",\n \"has_content\": \"\",\n \"content\": {},\n \"html\": {}\n },\n {\n \"keyword_id\": \"\",\n \"keyword\": \"\",\n \"keyword_url\": \"\",\n \"has_content\": \"\",\n \"content\": {},\n \"html\": {}\n }\n ]\n },\n \"cache_refreshed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88051894-c1e9-4f60-ba0b-5fe983b04586", "name": "Bad request - unknown parameter, out-of-range value, or invalid input.", "originalRequest": { "url": { "path": [ "projects", ":project", "reports", ":report_number", "content" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2872be0-2ee8-4f6e-a931-6cc0a0f325de", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "projects", ":project", "reports", ":report_number", "content" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ae94d64-9c89-4979-9df6-e09550e3957f", "name": "Token is valid but access is denied (wrong agency or non-whitelisted IP).", "originalRequest": { "url": { "path": [ "projects", ":project", "reports", ":report_number", "content" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27c0b1cf-6ab4-4394-af98-3b17a4c422a7", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "projects", ":project", "reports", ":report_number", "content" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "keywords", "description": "", "item": [ { "id": "6fc39a67-65d1-483c-921a-8eb079dbb6ef", "name": "Keywords for a project with content coverage", "request": { "name": "Keywords for a project with content coverage", "description": { "content": "Returns all keywords tracked for a project, with content coverage statistics.\n\n`content_action_ids` is a sorted array of report numbers (1-26) that contain generated content for\nthe keyword. This lets you quickly audit which reports have covered a keyword without fetching content.\n\nUse `content_count === 0` to find keywords that have never received content, or compare\n`content_action_ids` against your expected set to spot gaps.\n", "type": "text/plain" }, "url": { "path": [ "projects", ":project", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "project", "disabled": false, "description": { "content": "(Required) Project ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "81fd2f7f-43a8-4442-aab8-e927cc6aa8ec", "name": "List of keywords with content coverage statistics.", "originalRequest": { "url": { "path": [ "projects", ":project", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"keyword\": \"\",\n \"url\": \"\",\n \"create_date\": \"\",\n \"latest_position\": \"\",\n \"status_200\": \"\",\n \"content_count\": \"\",\n \"content_action_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"keyword\": \"\",\n \"url\": \"\",\n \"create_date\": \"\",\n \"latest_position\": \"\",\n \"status_200\": \"\",\n \"content_count\": \"\",\n \"content_action_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"cache_refreshed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43ee6740-dff4-4c3b-99c1-0a524c1e113c", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "projects", ":project", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b01e304-1ad1-41e5-bb33-55b2888ca9b0", "name": "Token is valid but access is denied (wrong agency or non-whitelisted IP).", "originalRequest": { "url": { "path": [ "projects", ":project", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b850e8cc-dfd8-47ad-8418-f24233d85095", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "projects", ":project", "keywords" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "countries", "description": "", "item": [ { "id": "11ebf51e-746a-4f6b-8506-bed3d0cfef4a", "name": "List all countries", "request": { "name": "List all countries", "description": { "content": "Returns the full list of countries available in Trakk. Use IDs to resolve the `country` field on project detail objects. Not cached.", "type": "text/plain" }, "url": { "path": [ "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b24a3416-5ee6-41d8-aa80-2f4d5e7b61a2", "name": "List of all countries.", "originalRequest": { "url": { "path": [ "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c298f44-1953-4782-9e4f-96506f206bd8", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{country}", "description": "", "item": [ { "id": "d927ca7a-c559-4c25-8521-27edd23ac1d3", "name": "Single country by ID", "request": { "name": "Single country by ID", "description": { "content": "Returns a single country by its ID. Not cached.", "type": "text/plain" }, "url": { "path": [ "countries", ":country" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "country", "disabled": false, "description": { "content": "(Required) Country ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b034a306-2215-463b-b96d-9e4e345a15e4", "name": "Country.", "originalRequest": { "url": { "path": [ "countries", ":country" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"label\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba4bcaeb-3fd1-41e3-835e-7500b41b27ff", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "countries", ":country" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a6ce5ff-9870-4b12-aed7-0709b04636fa", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "countries", ":country" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "languages", "description": "", "item": [ { "id": "2e357f35-6938-4a72-b556-f170b034dbdc", "name": "List all languages", "request": { "name": "List all languages", "description": { "content": "Returns all languages available in Trakk. Used to resolve `text_language` and `report_language` on project detail objects. Not cached.", "type": "text/plain" }, "url": { "path": [ "languages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "166a53bb-7b9f-44a0-8817-40bf03fe36d4", "name": "List of all languages.", "originalRequest": { "url": { "path": [ "languages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"label\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf3e2996-97b3-4f1d-b682-eaa220607828", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "languages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{language}", "description": "", "item": [ { "id": "e3243843-a040-466b-a487-b01b0dadd283", "name": "Single language by ID", "request": { "name": "Single language by ID", "description": { "content": "Returns a single language by its ID. Not cached.", "type": "text/plain" }, "url": { "path": [ "languages", ":language" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "language", "disabled": false, "description": { "content": "(Required) Language ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "af381e21-475b-4f7f-9fa1-abb9873b284a", "name": "Language.", "originalRequest": { "url": { "path": [ "languages", ":language" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"label\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "927d1f85-6753-4ab6-9825-75401610c02d", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "languages", ":language" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dabefef-54bf-4c1d-8910-44b85addc207", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "languages", ":language" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "users", "description": "", "item": [ { "id": "09f217ec-2e7a-49c8-8f49-c2f09951570a", "name": "List users visible to your token", "request": { "name": "List users visible to your token", "description": { "content": "Returns all Trakk users visible to your token. Use to resolve `managing_user`, `created_by`,\n`approved_by`, and `managed_by` fields on project and report objects. Not cached.\n", "type": "text/plain" }, "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2f125c47-fcf8-4dff-b3b7-a88c59955b57", "name": "List of users.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd574b3d-4150-4be4-b9b4-25edcc866d07", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{user}", "description": "", "item": [ { "id": "3d70ab64-a557-49ad-acde-8491792bf651", "name": "Single user by ID", "request": { "name": "Single user by ID", "description": { "content": "Returns a single Trakk user by their ID. Not cached.", "type": "text/plain" }, "url": { "path": [ "users", ":user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "user", "disabled": false, "description": { "content": "(Required) User ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "90b97b83-73e7-41d5-954f-e8b25ef26e93", "name": "User.", "originalRequest": { "url": { "path": [ "users", ":user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"agency\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74710024-6560-431d-9e04-56601e7ad511", "name": "Missing or invalid Bearer token.", "originalRequest": { "url": { "path": [ "users", ":user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b0c7bc4-0181-4e5f-bdd2-eb89a8b55d00", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "users", ":user" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://admin.trakk.ai/api/v1" }, { "key": "bearerToken", "value": "", "type": "string" } ], "info": { "_postman_id": "9f3fade3-3052-4d00-ac9c-138c11a7521a", "name": "Trakk Agency API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Programmatic read access to your SEO projects, reports, and AI-generated content.\nDesigned for server-to-server integrations.\n\n## Authentication\nAll requests require a Bearer token in the `Authorization` header:\n```\nAuthorization: Bearer \n```\nTokens have a status (`active` or `disabled`) and can be restricted to specific IP ranges (single IPs or CIDR ranges).\n\n## Rate limits\nDefault limits are 60 requests/minute and 1 000 requests/hour. If you exceed a limit the API returns `429` with a `Retry-After` header. Current usage is exposed via `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` response headers.\n\n## Response shapes\n- `GET /me` returns a bare object (no `data` wrapper).\n- Single-resource endpoints return `{ \"data\": { ... } }`.\n- Collection endpoints return `{ \"data\": [ ... ] }`.\n- Only `GET /projects` is paginated - it also includes `meta` and `links` objects.\n- Cached endpoints include a `cache_refreshed_at` ISO 8601 timestamp. The cache TTL is 1 hour and is invalidated automatically when data changes.\n\n## Errors\nAll error responses use `{ \"error\": { \"code\": \"...\", \"message\": \"...\" } }`.\n\n## Versioning\nNon-breaking additions (new fields, new enum values, new parameters, new endpoints) may be added to v1 without a version bump. Build defensively - ignore unknown fields.\n\n\nContact Support:\n Email: dev-support@trakk.ai", "type": "text/plain" } } }