{ "item": [ { "name": "api", "description": "", "item": [ { "name": "discovery", "description": "", "item": [ { "name": "ads", "description": "", "item": [ { "id": "f6b9d88b-ecaf-4bea-aef3-c12849600800", "name": "Search the ad corpus", "request": { "name": "Search the ad corpus", "description": { "content": "Full ad filter matrix + keyset cursor. `limit` default 20, max 250.\n`most_relevant` uses `ts_rank` when `query` is present; otherwise it\nfalls back to `newest`.\n\n**Credits:** 1 per ad returned (`ad-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "discovery", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1d32eaad-3256-4da5-b72d-dce5136be60e", "name": "Paginated Ad DTO list.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n },\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": [\n \"\",\n \"\"\n ],\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3343b054-c44e-46f4-b332-63a51331b13d", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bce1509-d16f-4362-84f4-a5774475a369", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "discovery", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac9e1f4c-17bf-4e46-a244-c1f1106d4328", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4341c4fa-4e4e-4385-b3fd-83033bbf00c7", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "discovery", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fafbebca-6f53-4946-acd4-ce632496742d", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "discovery", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25f7cccd-230d-4776-88d5-a3dd8126702f", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "impressions", "description": "", "item": [ { "id": "8d476639-22e7-41e5-9c58-b72b35dd3a8b", "name": "Ads sorted by impressions", "request": { "name": "Ads sorted by impressions", "description": { "content": "Cypher compat extension. Ads sorted by impressions (high to low).\nParams: `brand`/`q`, `platform`, `min_days`. `limit` default 20, max 100.\n\n**Credits:** 1 per ad returned (`ad-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "discovery", "ads", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name or keyword. Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Only include ads running at least this many days.", "type": "text/plain" }, "key": "min_days", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3dbe0be8-9983-4e78-b39f-756a6f0c2c59", "name": "Paginated Ad DTO list.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name or keyword. Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Only include ads running at least this many days.", "type": "text/plain" }, "key": "min_days", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n },\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": [\n \"\",\n \"\"\n ],\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76f6a038-0574-454e-8178-f09a9897d089", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name or keyword. Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Only include ads running at least this many days.", "type": "text/plain" }, "key": "min_days", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59b357ca-3803-4021-bc21-b5ab9bc4fa7a", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name or keyword. Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Only include ads running at least this many days.", "type": "text/plain" }, "key": "min_days", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6b83d10-2245-4054-9eaa-7351393aa593", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name or keyword. Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Only include ads running at least this many days.", "type": "text/plain" }, "key": "min_days", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eccb2666-ccb1-447a-83c0-d8c74fd7d203", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name or keyword. Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Only include ads running at least this many days.", "type": "text/plain" }, "key": "min_days", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "870a9362-bfa5-4ac7-ba6c-d0be18e2ac9b", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name or keyword. Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Only include ads running at least this many days.", "type": "text/plain" }, "key": "min_days", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8a0411c-1561-447c-846c-4b328a235f24", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name or keyword. Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Only include ads running at least this many days.", "type": "text/plain" }, "key": "min_days", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "by-brand", "description": "", "item": [ { "id": "0d963214-fcd7-4aa9-9cfa-d7904298c7b5", "name": "Ads for one brand, sorted by impressions", "request": { "name": "Ads for one brand, sorted by impressions", "description": { "content": "Cypher compat extension. `brand`/`q` is required → **400** if missing.\n`sort` ∈ `impressions` / `newest` / `oldest` / `longest`. `limit`\ndefault 20, max 100 + `offset`.\n\n**Credits:** 1 per ad returned (`ad-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "discovery", "ads", "impressions", "by-brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name (required). Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Sort order. Default `impressions`. (This can only be one of impressions,newest,oldest,longest)", "type": "text/plain" }, "key": "sort", "value": "impressions" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`, `google`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "When `true`, only return active ads.", "type": "text/plain" }, "key": "active_only", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a0b85376-2494-4704-8923-8b9c7fa8d336", "name": "Paginated Ad DTO list.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions", "by-brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name (required). Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Sort order. Default `impressions`. (This can only be one of impressions,newest,oldest,longest)", "type": "text/plain" }, "key": "sort", "value": "impressions" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`, `google`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "When `true`, only return active ads.", "type": "text/plain" }, "key": "active_only", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n },\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": [\n \"\",\n \"\"\n ],\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10878c61-93d2-45f3-b740-0e465c2a6d98", "name": "Handler-level 400 (e.g. missing `brand` on impressions-by-brand).", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions", "by-brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name (required). Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Sort order. Default `impressions`. (This can only be one of impressions,newest,oldest,longest)", "type": "text/plain" }, "key": "sort", "value": "impressions" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`, `google`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "When `true`, only return active ads.", "type": "text/plain" }, "key": "active_only", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2d054df-b6ff-421e-a78d-cfcfd97b32c8", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions", "by-brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name (required). Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Sort order. Default `impressions`. (This can only be one of impressions,newest,oldest,longest)", "type": "text/plain" }, "key": "sort", "value": "impressions" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`, `google`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "When `true`, only return active ads.", "type": "text/plain" }, "key": "active_only", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "434fc819-6cd4-4a3d-a1fc-91305cd5be22", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions", "by-brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name (required). Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Sort order. Default `impressions`. (This can only be one of impressions,newest,oldest,longest)", "type": "text/plain" }, "key": "sort", "value": "impressions" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`, `google`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "When `true`, only return active ads.", "type": "text/plain" }, "key": "active_only", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55b37cee-2d8c-4199-95cf-32b6006d1dc8", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions", "by-brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name (required). Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Sort order. Default `impressions`. (This can only be one of impressions,newest,oldest,longest)", "type": "text/plain" }, "key": "sort", "value": "impressions" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`, `google`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "When `true`, only return active ads.", "type": "text/plain" }, "key": "active_only", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e276094-a208-4b0e-aaf1-5e1643945974", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions", "by-brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name (required). Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Sort order. Default `impressions`. (This can only be one of impressions,newest,oldest,longest)", "type": "text/plain" }, "key": "sort", "value": "impressions" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`, `google`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "When `true`, only return active ads.", "type": "text/plain" }, "key": "active_only", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbcc9bc5-01a2-4f08-b09a-464b8afe3f34", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions", "by-brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name (required). Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Sort order. Default `impressions`. (This can only be one of impressions,newest,oldest,longest)", "type": "text/plain" }, "key": "sort", "value": "impressions" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`, `google`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "When `true`, only return active ads.", "type": "text/plain" }, "key": "active_only", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16d3f986-6155-4d4b-af80-685a5e921edd", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "discovery", "ads", "impressions", "by-brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand name (required). Alias `q`.", "type": "text/plain" }, "key": "brand", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Sort order. Default `impressions`. (This can only be one of impressions,newest,oldest,longest)", "type": "text/plain" }, "key": "sort", "value": "impressions" }, { "disabled": false, "description": { "content": "Filter by platform (`facebook`, `instagram`, `tiktok`, `google`).", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "When `true`, only return active ads.", "type": "text/plain" }, "key": "active_only", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "brands", "description": "", "item": [ { "id": "74a4a6a6-971c-4315-9269-e9a37e8b2e49", "name": "Search brands by name or domain", "request": { "name": "Search brands by name or domain", "description": { "content": "Single-page search. `query` / `q` / `domain` is required (422 if\nmissing). `limit` default 10, max 100. Honest `metadata.total_found`.\n\n**Credits:** 1 per brand returned (`brand-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "discovery", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 100.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "220e4617-818d-429c-9938-92070e5e5f6b", "name": "Paginated Brand DTO list.", "originalRequest": { "url": { "path": [ "api", "discovery", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 100.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ads_count\": \"\",\n \"avatar\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"industry\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"page_id\": \"\",\n \"publisher_platform\": null,\n \"verification_status\": \"\",\n \"website_url\": \"\"\n },\n {\n \"ads_count\": \"\",\n \"avatar\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"industry\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"page_id\": \"\",\n \"publisher_platform\": null,\n \"verification_status\": \"\",\n \"website_url\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01501f92-dc5b-46d6-89ba-4e7c385d254c", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "discovery", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 100.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "002f6f7c-1695-4ca1-bd78-915767f43d6a", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "discovery", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 100.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25a0fc13-4d9c-43c1-8e66-a637e534d740", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "discovery", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 100.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74c3dfac-635e-4460-922c-407cc168d116", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "discovery", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 100.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10eae623-ca26-40d2-b6d7-3967b046ec7e", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "discovery", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 100.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "964b2552-0de4-41bf-8774-7c94d4a29987", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "discovery", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 100.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "explore", "description": "", "item": [ { "id": "1141c870-8959-4026-bc39-f7f0d17486d0", "name": "Explore brands by recent ad activity", "request": { "name": "Explore brands by recent ad activity", "description": { "content": "Same ad filter matrix as `/api/discovery/ads`. `days` 1–365 (default\n30). `limit` default 20, max 10000. Ranked by measured ad count.\n\n**Credits:** 1 per brand returned (`brand-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "discovery", "brands", "explore" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Lookback window in days (1–365). Default 30.", "type": "text/plain" }, "key": "days", "value": "30" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 10000.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0cc525e2-d90c-4456-b86e-f42a4728b857", "name": "Paginated Brand DTO list.", "originalRequest": { "url": { "path": [ "api", "discovery", "brands", "explore" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Lookback window in days (1–365). Default 30.", "type": "text/plain" }, "key": "days", "value": "30" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 10000.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ads_count\": \"\",\n \"avatar\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"industry\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"page_id\": \"\",\n \"publisher_platform\": null,\n \"verification_status\": \"\",\n \"website_url\": \"\"\n },\n {\n \"ads_count\": \"\",\n \"avatar\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"industry\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"page_id\": \"\",\n \"publisher_platform\": null,\n \"verification_status\": \"\",\n \"website_url\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62192672-96ce-451a-acd3-c3333d02611f", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "discovery", "brands", "explore" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Lookback window in days (1–365). Default 30.", "type": "text/plain" }, "key": "days", "value": "30" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 10000.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e65a25c9-dd6f-434c-9420-f1f205403588", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "discovery", "brands", "explore" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Lookback window in days (1–365). Default 30.", "type": "text/plain" }, "key": "days", "value": "30" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 10000.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "589c6c17-974d-4ddf-b95a-df880f577adb", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "discovery", "brands", "explore" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Lookback window in days (1–365). Default 30.", "type": "text/plain" }, "key": "days", "value": "30" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 10000.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e516761a-b5a8-40ed-a221-84c0c913af72", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "discovery", "brands", "explore" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Lookback window in days (1–365). Default 30.", "type": "text/plain" }, "key": "days", "value": "30" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 10000.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "821ec774-6650-4c22-a86b-c93c39d13608", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "discovery", "brands", "explore" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Lookback window in days (1–365). Default 30.", "type": "text/plain" }, "key": "days", "value": "30" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 10000.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ebed632-6417-4377-9411-4b42eaf21abc", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "discovery", "brands", "explore" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Lookback window in days (1–365). Default 30.", "type": "text/plain" }, "key": "days", "value": "30" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 10000.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "ad", "description": "", "item": [ { "id": "465175b6-8a34-4010-a809-141e16d938e7", "name": "Get one ad by `ad_id`", "request": { "name": "Get one ad by `ad_id`", "description": { "content": "Query form of get-by-id. `ad_id` only — there is no `id` alias.\nResolves cuid → `externalId` (with or without `fb-`) → `foreplayId`.\nMissing/blank `ad_id` → 422. Unknown → 404.\n\nAn ad whose cuid is literally `duplicates` is **only** reachable via\nthis query form (the path `/api/ad/duplicates` is the duplicates\ncollection).\n\n**Credits:** 1 if found (`ad-lookup`).\n", "type": "text/plain" }, "url": { "path": [ "api", "ad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id. No `id` alias.", "type": "text/plain" }, "key": "ad_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6d23d0f9-c970-4034-8815-3be03ea38908", "name": "Single Ad DTO.", "originalRequest": { "url": { "path": [ "api", "ad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id. No `id` alias.", "type": "text/plain" }, "key": "ad_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": null,\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n },\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fffb15b9-3b48-44f9-bf30-d477b37cc84d", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "ad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id. No `id` alias.", "type": "text/plain" }, "key": "ad_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3ece13b-c25c-4289-ac73-efda3050c059", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "ad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id. No `id` alias.", "type": "text/plain" }, "key": "ad_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00ef1ed3-1942-4291-8dc3-9d21ea002540", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "ad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id. No `id` alias.", "type": "text/plain" }, "key": "ad_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f805146-afac-4782-82ee-ac7fe38c9af7", "name": "Unknown ad, brand, or board.", "originalRequest": { "url": { "path": [ "api", "ad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id. No `id` alias.", "type": "text/plain" }, "key": "ad_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3ab255c-e303-4ec6-a535-b0026056333e", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "ad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id. No `id` alias.", "type": "text/plain" }, "key": "ad_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "163eed83-1e5f-47e0-b912-45f1b4710145", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "ad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id. No `id` alias.", "type": "text/plain" }, "key": "ad_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93c2d1a4-14d6-4b2a-9b78-c64294555169", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "ad" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id. No `id` alias.", "type": "text/plain" }, "key": "ad_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{adId}", "description": "", "item": [ { "id": "028e59de-3af3-4a0e-9724-41b85c15b35e", "name": "Get one ad by path id", "request": { "name": "Get one ad by path id", "description": { "content": "Path form of get-by-id. Same resolver, DTO, 404, and credit as\n`GET /api/ad?ad_id=`. Foreplay documents this as `{ad_id}` — that\nspelling is **not** registered as a second path.\n\n**Credits:** 1 if found (`ad-lookup`).\n", "type": "text/plain" }, "url": { "path": [ "api", "ad", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "adId", "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2cbffa27-f1fa-41da-be63-0f8f9687caba", "name": "Single Ad DTO.", "originalRequest": { "url": { "path": [ "api", "ad", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": null,\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n },\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c1bbfce-f139-43c1-bea1-67a844b78998", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "ad", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d874e08c-e050-4834-9ca8-4f46bad1d0f5", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "ad", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8213cb4-14f4-458b-8057-c7c84793cab3", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "ad", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "372f71c0-4ac2-481a-8bf5-1b580c64441e", "name": "Unknown ad, brand, or board.", "originalRequest": { "url": { "path": [ "api", "ad", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bdd5632-eba4-4f14-952c-4c2cf812ce29", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "ad", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7807e57d-d414-4e3b-bd03-38c535e6ddae", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "ad", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "704941fd-4953-4fb3-96fa-e3d5fba55f9e", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "ad", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "duplicates", "description": "", "item": [ { "name": "{adId}", "description": "", "item": [ { "id": "466a8e6d-9e7a-4a89-9415-93436d43c19a", "name": "Other ads sharing the same media URL", "request": { "name": "Other ads sharing the same media URL", "description": { "content": "Other ads sharing the anchor's non-null `mediaUrl` (exact string\nequality), excluding the anchor. Hard-capped at 100. Unknown\nanchor → 404. Anchor with no media → 200 empty\n(`data: []`, `metadata.count: 0`, `total_found: 0`).\n\n**Credits:** 1 per ad returned (`ad-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "ad", "duplicates", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "adId", "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4fa40c41-86e0-481f-989d-0a5a6662cb95", "name": "Paginated Ad DTO list.", "originalRequest": { "url": { "path": [ "api", "ad", "duplicates", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n },\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": [\n \"\",\n \"\"\n ],\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7020874-1f0b-47fc-95d0-ce6b12ffae6d", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "ad", "duplicates", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6558b61-8a8c-47a4-a465-319218c81377", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "ad", "duplicates", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb683d83-6c95-4951-96e5-d3c9a20e98c5", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "ad", "duplicates", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "511d4ebf-bb29-4103-b4c1-5f2c56bf2ad8", "name": "Unknown ad, brand, or board.", "originalRequest": { "url": { "path": [ "api", "ad", "duplicates", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfe71099-bdeb-427e-be4b-a7dddb132f5b", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "ad", "duplicates", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0f0809f-0fec-4dc2-8644-20def3327b7a", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "ad", "duplicates", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2798c06-aedf-4002-8908-32ae68f4e909", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "ad", "duplicates", ":adId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Ad cuid, Meta library id, or Foreplay id (Next.js `[adId]`).", "type": "text/plain" }, "type": "any", "value": "", "key": "adId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "brand", "description": "", "item": [ { "name": "getAdsByBrandId", "description": "", "item": [ { "id": "e97197f2-cb35-4c30-85f5-acc114595e32", "name": "Ads for one or more brand ids", "request": { "name": "Ads for one or more brand ids", "description": { "content": "`brand_ids` (comma or repeated; alias `brand_id`) are Brand cuids or\n`foreplayBrandId`s, max 50 unique. Missing → 422. Zero resolved\nnames → 404. Full filter matrix + keyset cursor + `limit` ≤250.\n\n`collect` is accepted-and-ignored (no on-demand scrape). When the\nparam is present, `metadata.collect_ignored` is `true`.\n\n**Credits:** 1 per ad returned (`ad-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "brand", "getAdsByBrandId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand cuid or `foreplayBrandId`. Repeatable or comma-separated. Max 50 unique. Alias `brand_id`.", "type": "text/plain" }, "key": "brand_ids", "value": "" }, { "disabled": false, "description": { "content": "Brand cuid or `foreplayBrandId`. Repeatable or comma-separated. Max 50 unique. Alias `brand_id`.", "type": "text/plain" }, "key": "brand_ids", "value": "" }, { "disabled": false, "description": { "content": "Alias for `brand_ids`.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Accepted and ignored. Sets `metadata.collect_ignored` when present.", "type": "text/plain" }, "key": "collect", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "349b1e62-d197-474d-9400-a4d1d4844ec2", "name": "Paginated Ad DTO list.", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByBrandId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand cuid or `foreplayBrandId`. Repeatable or comma-separated. Max 50 unique. Alias `brand_id`.", "type": "text/plain" }, "key": "brand_ids", "value": "" }, { "disabled": false, "description": { "content": "Alias for `brand_ids`.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Accepted and ignored. Sets `metadata.collect_ignored` when present.", "type": "text/plain" }, "key": "collect", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n },\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": [\n \"\",\n \"\"\n ],\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a352cbeb-205c-461f-819e-88dfc26689cd", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByBrandId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand cuid or `foreplayBrandId`. Repeatable or comma-separated. Max 50 unique. Alias `brand_id`.", "type": "text/plain" }, "key": "brand_ids", "value": "" }, { "disabled": false, "description": { "content": "Alias for `brand_ids`.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Accepted and ignored. Sets `metadata.collect_ignored` when present.", "type": "text/plain" }, "key": "collect", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34e86755-3fc6-4511-99b9-4a98e7ca2494", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByBrandId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand cuid or `foreplayBrandId`. Repeatable or comma-separated. Max 50 unique. Alias `brand_id`.", "type": "text/plain" }, "key": "brand_ids", "value": "" }, { "disabled": false, "description": { "content": "Alias for `brand_ids`.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Accepted and ignored. Sets `metadata.collect_ignored` when present.", "type": "text/plain" }, "key": "collect", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45b9d78d-309d-45cb-a50b-294e30fee3d8", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByBrandId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand cuid or `foreplayBrandId`. Repeatable or comma-separated. Max 50 unique. Alias `brand_id`.", "type": "text/plain" }, "key": "brand_ids", "value": "" }, { "disabled": false, "description": { "content": "Alias for `brand_ids`.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Accepted and ignored. Sets `metadata.collect_ignored` when present.", "type": "text/plain" }, "key": "collect", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1fb48c2-2581-41a4-9f06-e62a5c156e71", "name": "Unknown ad, brand, or board.", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByBrandId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand cuid or `foreplayBrandId`. Repeatable or comma-separated. Max 50 unique. Alias `brand_id`.", "type": "text/plain" }, "key": "brand_ids", "value": "" }, { "disabled": false, "description": { "content": "Alias for `brand_ids`.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Accepted and ignored. Sets `metadata.collect_ignored` when present.", "type": "text/plain" }, "key": "collect", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccf583c2-dd82-4725-891b-04535e7fc87e", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByBrandId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand cuid or `foreplayBrandId`. Repeatable or comma-separated. Max 50 unique. Alias `brand_id`.", "type": "text/plain" }, "key": "brand_ids", "value": "" }, { "disabled": false, "description": { "content": "Alias for `brand_ids`.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Accepted and ignored. Sets `metadata.collect_ignored` when present.", "type": "text/plain" }, "key": "collect", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "703e52a0-ade0-4263-bc67-85f58f5fc6c8", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByBrandId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand cuid or `foreplayBrandId`. Repeatable or comma-separated. Max 50 unique. Alias `brand_id`.", "type": "text/plain" }, "key": "brand_ids", "value": "" }, { "disabled": false, "description": { "content": "Alias for `brand_ids`.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Accepted and ignored. Sets `metadata.collect_ignored` when present.", "type": "text/plain" }, "key": "collect", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34c8aefe-b11d-4b96-9ae2-affd1d07e5a1", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByBrandId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Brand cuid or `foreplayBrandId`. Repeatable or comma-separated. Max 50 unique. Alias `brand_id`.", "type": "text/plain" }, "key": "brand_ids", "value": "" }, { "disabled": false, "description": { "content": "Alias for `brand_ids`.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Accepted and ignored. Sets `metadata.collect_ignored` when present.", "type": "text/plain" }, "key": "collect", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "getAdsByPageId", "description": "", "item": [ { "id": "c981f2a8-0f0f-4b2b-a260-120d464ec5a2", "name": "Ads for a Meta page id", "request": { "name": "Ads for a Meta page id", "description": { "content": "Numeric Meta `page_id` required (422 otherwise). Matches `Ad.brandId`\nor `Brand.pageId`. Unknown numeric page → **200 empty** (not 404).\nSame filters / cursor / limit as getAdsByBrandId.\n\n**Credits:** 1 per ad returned (`ad-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "brand", "getAdsByPageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Numeric Meta page id.", "type": "text/plain" }, "key": "page_id", "value": "23607" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "772279dc-43ac-4907-985b-35a9b2498012", "name": "Paginated Ad DTO list.", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByPageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Numeric Meta page id.", "type": "text/plain" }, "key": "page_id", "value": "23607" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n },\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": [\n \"\",\n \"\"\n ],\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd0f61f3-d4f1-4a48-98cf-8f1645c64907", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByPageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Numeric Meta page id.", "type": "text/plain" }, "key": "page_id", "value": "23607" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b18317b-7cbc-43c2-8476-8d5abcacc926", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByPageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Numeric Meta page id.", "type": "text/plain" }, "key": "page_id", "value": "23607" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b44cb0b-f9cf-4583-9606-d500ac66223f", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByPageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Numeric Meta page id.", "type": "text/plain" }, "key": "page_id", "value": "23607" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9353d751-e93b-49f2-9de4-892b788c1414", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByPageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Numeric Meta page id.", "type": "text/plain" }, "key": "page_id", "value": "23607" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "888b9d11-fdca-459d-bf2a-68320d527550", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByPageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Numeric Meta page id.", "type": "text/plain" }, "key": "page_id", "value": "23607" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08d3f21f-6e73-429d-bee1-753083d273f4", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "brand", "getAdsByPageId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Numeric Meta page id.", "type": "text/plain" }, "key": "page_id", "value": "23607" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 250.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "getBrandsByDomain", "description": "", "item": [ { "id": "1b3817ad-9a47-4654-84f1-388734dec2bd", "name": "Brands matching a domain", "request": { "name": "Brands matching a domain", "description": { "content": "`domain` (aliases `query` / `q`) is required → 422 if missing.\nScheme / `www.` / path / port are stripped. `limit` default 10, max 10.\nRanked by measured ad count descending. Matches `Brand.domain` and\n`websites` JSON — not `name` ILIKE.\n\n**Credits:** 1 per brand returned (`brand-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "brand", "getBrandsByDomain" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hostname or URL. Aliases `query` / `q`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "63f53e03-a187-4467-ad03-a5f796ca5a9d", "name": "Paginated Brand DTO list.", "originalRequest": { "url": { "path": [ "api", "brand", "getBrandsByDomain" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hostname or URL. Aliases `query` / `q`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ads_count\": \"\",\n \"avatar\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"industry\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"page_id\": \"\",\n \"publisher_platform\": null,\n \"verification_status\": \"\",\n \"website_url\": \"\"\n },\n {\n \"ads_count\": \"\",\n \"avatar\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"industry\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"page_id\": \"\",\n \"publisher_platform\": null,\n \"verification_status\": \"\",\n \"website_url\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc55e9da-c395-457b-bfba-57ae82893b0b", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "brand", "getBrandsByDomain" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hostname or URL. Aliases `query` / `q`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3cf9164-2914-4076-84da-6e3c1af503cc", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "brand", "getBrandsByDomain" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hostname or URL. Aliases `query` / `q`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42678dc2-c8c4-4811-845b-aa1eb61e83a6", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "brand", "getBrandsByDomain" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hostname or URL. Aliases `query` / `q`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b8f4cbc-2c7f-46fd-b012-b6a8d795c57e", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "brand", "getBrandsByDomain" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hostname or URL. Aliases `query` / `q`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9d8a5cd-f7bb-4dbf-912e-ef35ed0a3536", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "brand", "getBrandsByDomain" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hostname or URL. Aliases `query` / `q`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "992bc784-84ed-4830-8cd5-b23a3e7c8ece", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "brand", "getBrandsByDomain" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Hostname or URL. Aliases `query` / `q`.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "analytics", "description": "", "item": [ { "id": "93930768-4484-4b48-b3ff-19bb3c062c77", "name": "Per-day brand analytics", "request": { "name": "Per-day brand analytics", "description": { "content": "`id` is a Brand cuid or numeric page id (**not** `foreplayBrandId`).\nUnknown → 404. `start_date` / `end_date` are UTC date-only. Default\nwindow is the last 30 days; max 366 inclusive days.\n\nEach row is an active day with `ads_started`, running `live_count`,\n`format_mix`, and computed `runtime_buckets`. Computed from `Ad` —\nnever `durationDays`, never `Brand.analytics`.\n\n**Credits:** 1 per row returned (`ad-list`). Empty is free.\n", "type": "text/plain" }, "url": { "path": [ "api", "brand", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or numeric Meta page id. Not `foreplayBrandId`.", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "46fc9f8d-2357-43aa-a762-85981ec21013", "name": "Per-day analytics rows.", "originalRequest": { "url": { "path": [ "api", "brand", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or numeric Meta page id. Not `foreplayBrandId`.", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ads_started\": \"\",\n \"date\": \"\",\n \"format_mix\": {\n \"image\": \"\",\n \"video\": \"\",\n \"other\": \"\"\n },\n \"live_count\": \"\",\n \"runtime_buckets\": {\n \"lt7\": \"\",\n \"d7to30\": \"\",\n \"d30to90\": \"\",\n \"d90plus\": \"\"\n }\n },\n {\n \"ads_started\": \"\",\n \"date\": \"\",\n \"format_mix\": {\n \"image\": \"\",\n \"video\": \"\",\n \"other\": \"\"\n },\n \"live_count\": \"\",\n \"runtime_buckets\": {\n \"lt7\": \"\",\n \"d7to30\": \"\",\n \"d30to90\": \"\",\n \"d90plus\": \"\"\n }\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c884aff1-cc88-4c88-ad56-91594c79c1e7", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "brand", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or numeric Meta page id. Not `foreplayBrandId`.", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5dbad9b-efc3-428f-99ea-73c7063b9e84", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "brand", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or numeric Meta page id. Not `foreplayBrandId`.", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96d80438-ada8-4e0e-9266-1f2c821ce94b", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "brand", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or numeric Meta page id. Not `foreplayBrandId`.", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "943ce840-cb4d-485f-a008-c6e4db55692b", "name": "Unknown ad, brand, or board.", "originalRequest": { "url": { "path": [ "api", "brand", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or numeric Meta page id. Not `foreplayBrandId`.", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2781dce0-3510-4a2a-a1b2-04767993f70f", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "brand", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or numeric Meta page id. Not `foreplayBrandId`.", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "617fe2f1-ef25-412c-bdb1-b55f1f035c49", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "brand", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or numeric Meta page id. Not `foreplayBrandId`.", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "711204d9-1f14-4f84-8cd9-50f5a88fe38c", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "brand", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or numeric Meta page id. Not `foreplayBrandId`.", "type": "text/plain" }, "key": "id", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "v1", "description": "", "item": [ { "name": "brands", "description": "", "item": [ { "id": "6b8d7c86-4faf-4c95-99de-b776d38b4436", "name": "List brands (legacy v1 shape)", "request": { "name": "List brands (legacy v1 shape)", "description": { "content": "Cypher compat extension. Envelope **superset** of `{brands, nextCursor}`\n(`data` + `metadata` are added). Opaque keyset cursor. Optional `q`.\n`limit` default 20, max 100. `brands` are raw Prisma Brand rows, not\nthe Foreplay Brand DTO.\n\n**Credits:** 1 per brand returned (`brand-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional case-insensitive name filter.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ce619021-3a67-4391-9e3b-24cc01a1db56", "name": "Legacy `{brands, nextCursor}` plus envelope.", "originalRequest": { "url": { "path": [ "api", "v1", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional case-insensitive name filter.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"brands\": [\n \"\",\n \"\"\n ],\n \"data\": \"\",\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n },\n \"nextCursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a738c47-8162-44a4-a9db-1c729a3dba56", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "v1", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional case-insensitive name filter.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "defb962f-5183-4bf2-a2dc-c54eefa30087", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "v1", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional case-insensitive name filter.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79411b73-4e09-4a69-b1c3-2ac073aeeb14", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "v1", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional case-insensitive name filter.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c8f205d-3728-4693-a366-1d835b04a72f", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "v1", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional case-insensitive name filter.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8816c3a8-235a-432d-82c5-49d3942391da", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "v1", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional case-insensitive name filter.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5529508e-adf2-4ed5-a162-c0bbc9b80ef6", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "v1", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Optional case-insensitive name filter.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 20, max 100.", "type": "text/plain" }, "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{brandId}", "description": "", "item": [ { "name": "ads", "description": "", "item": [ { "id": "2b52761e-cf53-434d-9ad2-829ac12ac22f", "name": "Ads for a brand (legacy v1 shape)", "request": { "name": "Ads for a brand (legacy v1 shape)", "description": { "content": "Cypher compat extension. Envelope **superset** of\n`{brandId, totalFound, ads}`. Matches `brandId` **or**\ncase-insensitive `brandName`. `active=true|false`. `limit` default\n100, max 200 (`parseLimit`). `ads` are raw Prisma Ad rows, not the\nForeplay Ad DTO.\n\n**Credits:** 1 per ad returned (`ad-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "brands", ":brandId", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`false`, filter `isActive`. Omitted = all. (This can only be one of true,false)", "type": "text/plain" }, "key": "active", "value": "true" }, { "disabled": false, "description": { "content": "Page size. Default 100, max 200.", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [ { "type": "any", "value": "", "key": "brandId", "disabled": false, "description": { "content": "(Required) Brand cuid or brand name (case-insensitive).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5b647b04-c9f7-4fa2-bd58-f5f7c786e2b5", "name": "Legacy `{brandId, totalFound, ads}` plus envelope.", "originalRequest": { "url": { "path": [ "api", "v1", "brands", ":brandId", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`false`, filter `isActive`. Omitted = all. (This can only be one of true,false)", "type": "text/plain" }, "key": "active", "value": "true" }, { "disabled": false, "description": { "content": "Page size. Default 100, max 200.", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or brand name (case-insensitive).", "type": "text/plain" }, "type": "any", "value": "", "key": "brandId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"brandId\": \"\",\n \"totalFound\": \"\",\n \"ads\": [\n \"\",\n \"\"\n ],\n \"data\": \"\",\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6a472ce-aeee-4c8a-86c7-25434d210e2b", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "v1", "brands", ":brandId", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`false`, filter `isActive`. Omitted = all. (This can only be one of true,false)", "type": "text/plain" }, "key": "active", "value": "true" }, { "disabled": false, "description": { "content": "Page size. Default 100, max 200.", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or brand name (case-insensitive).", "type": "text/plain" }, "type": "any", "value": "", "key": "brandId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "315a18b8-2f0d-42d7-a0d7-dae67b05b182", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "v1", "brands", ":brandId", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`false`, filter `isActive`. Omitted = all. (This can only be one of true,false)", "type": "text/plain" }, "key": "active", "value": "true" }, { "disabled": false, "description": { "content": "Page size. Default 100, max 200.", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or brand name (case-insensitive).", "type": "text/plain" }, "type": "any", "value": "", "key": "brandId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "141e0181-e493-4c54-b928-7311b3ee9e5d", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "v1", "brands", ":brandId", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`false`, filter `isActive`. Omitted = all. (This can only be one of true,false)", "type": "text/plain" }, "key": "active", "value": "true" }, { "disabled": false, "description": { "content": "Page size. Default 100, max 200.", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or brand name (case-insensitive).", "type": "text/plain" }, "type": "any", "value": "", "key": "brandId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24ba8220-69ef-4405-bf79-7d5eed3e75ec", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "v1", "brands", ":brandId", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`false`, filter `isActive`. Omitted = all. (This can only be one of true,false)", "type": "text/plain" }, "key": "active", "value": "true" }, { "disabled": false, "description": { "content": "Page size. Default 100, max 200.", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or brand name (case-insensitive).", "type": "text/plain" }, "type": "any", "value": "", "key": "brandId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d65e5dba-d293-48bc-8aae-0d004fe77348", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "v1", "brands", ":brandId", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`false`, filter `isActive`. Omitted = all. (This can only be one of true,false)", "type": "text/plain" }, "key": "active", "value": "true" }, { "disabled": false, "description": { "content": "Page size. Default 100, max 200.", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or brand name (case-insensitive).", "type": "text/plain" }, "type": "any", "value": "", "key": "brandId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09da1a54-1915-4406-899b-fafb4dadc4da", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "v1", "brands", ":brandId", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`false`, filter `isActive`. Omitted = all. (This can only be one of true,false)", "type": "text/plain" }, "key": "active", "value": "true" }, { "disabled": false, "description": { "content": "Page size. Default 100, max 200.", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Brand cuid or brand name (case-insensitive).", "type": "text/plain" }, "type": "any", "value": "", "key": "brandId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "swipefile", "description": "", "item": [ { "name": "ads", "description": "", "item": [ { "id": "f48a8581-5577-42ee-9420-f353fd4fc18c", "name": "Saved ads for the authenticated user", "request": { "name": "Saved ads for the authenticated user", "description": { "content": "Personal key required. Offset/limit (default 10, max 250) — **not**\ncursor. Orders `saved_newest` (default) / `newest` / `oldest` /\n`longest_running`. Accepts the ad filter matrix.\n\n**Credits:** 1 per ad returned (`ad-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "swipefile", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Swipefile sort. Default `saved_newest`. (This can only be one of saved_newest,newest,oldest,longest_running)", "type": "text/plain" }, "key": "order", "value": "saved_newest" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "deb3678a-37a6-4f61-ade5-772c9d5716cb", "name": "Paginated Ad DTO list.", "originalRequest": { "url": { "path": [ "api", "swipefile", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Swipefile sort. Default `saved_newest`. (This can only be one of saved_newest,newest,oldest,longest_running)", "type": "text/plain" }, "key": "order", "value": "saved_newest" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n },\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": [\n \"\",\n \"\"\n ],\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a5f9d1d-5a87-484c-adc5-2781572b61c5", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "swipefile", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Swipefile sort. Default `saved_newest`. (This can only be one of saved_newest,newest,oldest,longest_running)", "type": "text/plain" }, "key": "order", "value": "saved_newest" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8d4660a-0529-40b3-9038-440ab7320362", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "swipefile", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Swipefile sort. Default `saved_newest`. (This can only be one of saved_newest,newest,oldest,longest_running)", "type": "text/plain" }, "key": "order", "value": "saved_newest" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4fc41ad-5e06-4707-8f8c-e1606848a861", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "swipefile", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Swipefile sort. Default `saved_newest`. (This can only be one of saved_newest,newest,oldest,longest_running)", "type": "text/plain" }, "key": "order", "value": "saved_newest" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "039f6ed5-2d57-44a8-8024-388deb6c5278", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "swipefile", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Swipefile sort. Default `saved_newest`. (This can only be one of saved_newest,newest,oldest,longest_running)", "type": "text/plain" }, "key": "order", "value": "saved_newest" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9cbba5d-e3bb-4e11-8b4a-37acb878b80c", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "swipefile", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Swipefile sort. Default `saved_newest`. (This can only be one of saved_newest,newest,oldest,longest_running)", "type": "text/plain" }, "key": "order", "value": "saved_newest" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c00a26db-7bc8-4724-bd50-0e921b27efc1", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "swipefile", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Swipefile sort. Default `saved_newest`. (This can only be one of saved_newest,newest,oldest,longest_running)", "type": "text/plain" }, "key": "order", "value": "saved_newest" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "boards", "description": "", "item": [ { "id": "fcfd8fde-10c0-42b3-bf2f-ca8f8ec3b7e8", "name": "List the authenticated user's boards", "request": { "name": "List the authenticated user's boards", "description": { "content": "Personal key required. This documents the **keyed Foreplay envelope\nonly** — the session GET (raw array) is not the public contract.\nInvalid presented secrets must not fall through to the session array.\n\n`limit` omitted = all boards. `folders=true` synthesizes a Default\nfolder (`{folders:[{name:\"Default\", is_default:true, boards:[…]}]}`);\noffset/limit are ignored (`metadata.offset_limit_ignored`).\n\n**Credits:** 1 if the payload is non-empty (`flat-listing`).\n", "type": "text/plain" }, "url": { "path": [ "api", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`1`/`yes`, wrap boards in a synthesized Default folder.", "type": "text/plain" }, "key": "folders", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Omitted = all boards. Ignored when `folders=true`.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a0487485-6029-4245-acd4-dc8efeacc893", "name": "Keyed Foreplay board list (or synthesized folders).", "originalRequest": { "url": { "path": [ "api", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`1`/`yes`, wrap boards in a synthesized Default folder.", "type": "text/plain" }, "key": "folders", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Omitted = all boards. Ignored when `folders=true`.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ads_count\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"ads_count\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5797933b-878b-40df-964a-bf0ae6a4f1b6", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`1`/`yes`, wrap boards in a synthesized Default folder.", "type": "text/plain" }, "key": "folders", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Omitted = all boards. Ignored when `folders=true`.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31a8ab2e-7272-44c2-99bf-a4f390ec42f5", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`1`/`yes`, wrap boards in a synthesized Default folder.", "type": "text/plain" }, "key": "folders", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Omitted = all boards. Ignored when `folders=true`.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4934a79f-632c-40b3-93c5-bb944b056cab", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`1`/`yes`, wrap boards in a synthesized Default folder.", "type": "text/plain" }, "key": "folders", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Omitted = all boards. Ignored when `folders=true`.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13f1c7bc-c2dd-4eb3-b9dd-f8921cf4ed76", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`1`/`yes`, wrap boards in a synthesized Default folder.", "type": "text/plain" }, "key": "folders", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Omitted = all boards. Ignored when `folders=true`.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b65f7003-8cfb-4e26-8164-9c648b15ebb8", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`1`/`yes`, wrap boards in a synthesized Default folder.", "type": "text/plain" }, "key": "folders", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Omitted = all boards. Ignored when `folders=true`.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94f7a6bf-e197-4067-9af6-42c1226257ed", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `true`/`1`/`yes`, wrap boards in a synthesized Default folder.", "type": "text/plain" }, "key": "folders", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Omitted = all boards. Ignored when `folders=true`.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "board", "description": "", "item": [ { "name": "brands", "description": "", "item": [ { "id": "9b86387c-ed59-4ab5-a3f1-545a85841c80", "name": "Distinct brands of ads on an owned board", "request": { "name": "Distinct brands of ads on an owned board", "description": { "content": "Personal key required. `board_id` required. Cross-tenant / unknown\nboard → 404. `ads_count` is board-local. `limit` default 10, max 10.\n\n**Credits:** 1 if the payload is non-empty (`flat-listing`).\n", "type": "text/plain" }, "url": { "path": [ "api", "board", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4c1abc8f-b78b-406f-9d4a-8a6b46d8695f", "name": "Paginated Brand DTO list.", "originalRequest": { "url": { "path": [ "api", "board", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ads_count\": \"\",\n \"avatar\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"industry\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"page_id\": \"\",\n \"publisher_platform\": null,\n \"verification_status\": \"\",\n \"website_url\": \"\"\n },\n {\n \"ads_count\": \"\",\n \"avatar\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"industry\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"page_id\": \"\",\n \"publisher_platform\": null,\n \"verification_status\": \"\",\n \"website_url\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0da9714-87e7-42c7-a9b1-fc092d90c1ec", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "board", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dacd83d6-88e2-40b9-a918-2c3560ecee1d", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "board", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcb7126b-5044-4175-9531-e273057729ae", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "board", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e58bb455-b7ed-4db9-88a8-0a561b1594c0", "name": "Unknown ad, brand, or board.", "originalRequest": { "url": { "path": [ "api", "board", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0b08923-ebdf-4c81-aa9c-3fde5e1fece2", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "board", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0df7957c-e24f-4a69-969b-e38b4c85faff", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "board", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90b75546-4e08-4f0c-8113-b033e914de8c", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "board", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "ads", "description": "", "item": [ { "id": "77470b84-1699-4f9b-bd33-ba5485d013a0", "name": "Ads on an owned board", "request": { "name": "Ads on an owned board", "description": { "content": "Personal key required. `board_id` required → 422. Cross-tenant /\nunknown → 404 **before** the items query. Full filter matrix +\nkeyset cursor. `limit` default 10, max 250.\n\n**Credits:** 1 per ad returned (`ad-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "board", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "99941dad-25e3-4e00-a2cd-aa2e36f44e3b", "name": "Paginated Ad DTO list.", "originalRequest": { "url": { "path": [ "api", "board", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n },\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": [\n \"\",\n \"\"\n ],\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "907f420a-90d2-42f7-9e2e-f92546dbfda5", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "board", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f7898c0-8cf3-4ae6-8d6b-211556fb930c", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "board", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fd8e695-116e-4561-853d-99828311dfa4", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "board", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b2597d0-9230-4865-8f13-8f835bce07fe", "name": "Unknown ad, brand, or board.", "originalRequest": { "url": { "path": [ "api", "board", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bc94d3e-67c3-493d-a655-b162d65b5326", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "board", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "248e6eda-94a0-48e8-9aa7-42cd6924ae55", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "board", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bdb3766-0168-48ce-8f34-6892a75a9ba5", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "board", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Owned board cuid.", "type": "text/plain" }, "key": "board_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "spyder", "description": "", "item": [ { "name": "brands", "description": "", "item": [ { "id": "e31af607-0a25-4fd2-99a3-88d4239934da", "name": "Tracked brands for the authenticated user", "request": { "name": "Tracked brands for the authenticated user", "description": { "content": "Personal key required. Offset / `limit` default 10, max 10. Dedupes\nrepeated `(userId, lower(brandName))`. Empty library → 200\n`{data:[], count:0}`.\n\n**Credits:** 1 if the payload is non-empty (`flat-listing`).\n", "type": "text/plain" }, "url": { "path": [ "api", "spyder", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "995c786b-df0d-4287-9bc9-5bc18e0e6d41", "name": "Tracked-brand list.", "originalRequest": { "url": { "path": [ "api", "spyder", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ads_count\": \"\",\n \"avatar\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"industry\": \"\",\n \"last_checked\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"page_id\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"verification_status\": \"\",\n \"website_url\": \"\"\n },\n {\n \"ads_count\": \"\",\n \"avatar\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"industry\": \"\",\n \"last_checked\": \"\",\n \"name\": \"\",\n \"niches\": [\n \"\",\n \"\"\n ],\n \"page_id\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"verification_status\": \"\",\n \"website_url\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "44bbed1d-fc1f-46f4-a3c5-2376d7fc5acd", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "spyder", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "091e2737-66e7-4f1e-b28f-74feedaf957b", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "spyder", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2821e475-712b-421d-9260-8ce549cfee78", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "spyder", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7add0a2c-7919-4329-87b5-82eb7dc3ebc8", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "spyder", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac8d312e-29c4-49ce-a703-3bbcd8072db3", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "spyder", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63b4a700-f494-4fcc-82fb-1da2d8fa4914", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "spyder", "brands" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Offset pagination start. Default 0.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 10.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "brand", "description": "", "item": [ { "id": "648fa384-84e0-476b-a357-7444fc46f4d6", "name": "One tracked brand", "request": { "name": "One tracked brand", "description": { "content": "Personal key required. `brand_id` required → 422 (Brand cuid,\n`brandName`, or stored `TrackedBrand.brandId`). Untracked / other-user\n/ unknown → **403 `\"User not subscribed\"`** (never 404). `data` is a\n**single object**.\n\n**Credits:** 1 (`flat-listing`).\n", "type": "text/plain" }, "url": { "path": [ "api", "spyder", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8d0b6fdf-f4dd-4040-9eaf-f412ede60802", "name": "Single tracked brand (`data` is an object).", "originalRequest": { "url": { "path": [ "api", "spyder", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": {\n \"ads_count\": \"\",\n \"avatar\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"domain\": \"\",\n \"id\": \"\",\n \"industry\": \"\",\n \"last_checked\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"page_id\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"verification_status\": \"\",\n \"website_url\": \"\"\n },\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c8dd9bc-eca5-44f4-bc2d-d2a2ee31bff2", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "spyder", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b99ba405-8be0-4dfd-bd17-c06848aaa361", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "spyder", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d951386-b878-4e9f-8127-eefbfaff9018", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "spyder", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7957e1ec-a4b2-4593-bfc2-3f60c288f296", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "spyder", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "690d814a-2c61-43ac-bbf2-ffb93665e460", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "spyder", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "544067c7-ebf5-4f41-a205-bf7fde495b1a", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "spyder", "brand" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "ads", "description": "", "item": [ { "id": "db82e6e3-aadc-4a76-9ba7-26d8c5d91dd3", "name": "Ads for a tracked brand", "request": { "name": "Ads for a tracked brand", "description": { "content": "Personal key required. Tracked-check first → 403 `\"User not\nsubscribed\"` **before** the ads query. Then the full filter matrix +\nkeyset cursor. `limit` default 10, max 250.\n\n**Credits:** 1 per ad returned (`ad-list`).\n", "type": "text/plain" }, "url": { "path": [ "api", "spyder", "brand", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e72a9e0e-47a8-462e-a343-ac6246a44828", "name": "Paginated Ad DTO list.", "originalRequest": { "url": { "path": [ "api", "spyder", "brand", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"data\": [\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": null,\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n },\n {\n \"ad_id\": \"\",\n \"avatar\": \"\",\n \"cards\": \"\",\n \"content_filter\": \"\",\n \"cta_title\": \"\",\n \"cta_type\": \"\",\n \"cypher_url\": \"\",\n \"description\": \"\",\n \"display_format\": \"\",\n \"emotional_drivers\": \"\",\n \"full_transcription\": \"\",\n \"headline\": \"\",\n \"id\": \"\",\n \"image\": \"\",\n \"languages\": [\n \"\",\n \"\"\n ],\n \"likes\": \"\",\n \"link_url\": \"\",\n \"live\": \"\",\n \"market_target\": \"\",\n \"name\": \"\",\n \"niches\": [\n \"\",\n \"\"\n ],\n \"persona\": \"\",\n \"product_category\": \"\",\n \"publisher_platform\": [\n \"\",\n \"\"\n ],\n \"running_duration\": \"\",\n \"started_running\": \"\",\n \"thumbnail\": \"\",\n \"timestamped_transcription\": \"\",\n \"video\": \"\",\n \"video_duration\": \"\"\n }\n ],\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c50472f-b706-4fee-927d-70c4486156e3", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "spyder", "brand", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "762969a9-e065-4f9c-8258-c768600ede3b", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "spyder", "brand", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c32944fc-b723-4248-b1e7-6dd98dca181d", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "spyder", "brand", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca0ddad4-6ae4-4f23-8aa2-7ceec565809e", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "spyder", "brand", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af25678f-fecc-42b6-860b-dbda8cb75614", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "spyder", "brand", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69707bc8-66db-4f6f-92c0-b6c9ffc564fe", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "spyder", "brand", "ads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Brand cuid, brand name, or stored tracked-brand id.", "type": "text/plain" }, "key": "brand_id", "value": "" }, { "disabled": false, "description": { "content": "Keyword search. Alias `q`.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Alias for `query`.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Filter by live status. Distinct `true` / `false`; omitted = all.", "type": "text/plain" }, "key": "live", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `format`.", "type": "text/plain" }, "key": "display_format", "value": "" }, { "disabled": false, "description": { "content": "Alias for `display_format`.", "type": "text/plain" }, "key": "format", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Aliases `platform` / `platforms`.", "type": "text/plain" }, "key": "publisher_platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platform", "value": "" }, { "disabled": false, "description": { "content": "Alias for `publisher_platform`.", "type": "text/plain" }, "key": "platforms", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `niche`.", "type": "text/plain" }, "key": "niches", "value": "" }, { "disabled": false, "description": { "content": "Alias for `niches`.", "type": "text/plain" }, "key": "niche", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated. Alias `language`.", "type": "text/plain" }, "key": "languages", "value": "" }, { "disabled": false, "description": { "content": "Alias for `languages`.", "type": "text/plain" }, "key": "language", "value": "" }, { "disabled": false, "description": { "content": "Repeatable or comma-separated.", "type": "text/plain" }, "key": "market_target", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_min", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "video_duration_max", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_min_days", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "running_duration_max_days", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive start.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "UTC date-only (`YYYY-MM-DD`). Inclusive end.", "type": "text/plain" }, "key": "end_date", "value": "" }, { "disabled": false, "description": { "content": "Market country. Default `US`.", "type": "text/plain" }, "key": "country", "value": "US" }, { "disabled": false, "description": { "content": "Keyset order. `most_relevant` is `ts_rank` when `query` is present; otherwise falls back to `newest`. (This can only be one of newest,oldest,longest_running,most_relevant)", "type": "text/plain" }, "key": "order", "value": "newest" }, { "disabled": false, "description": { "content": "Opaque keyset cursor from the previous page. Hold `limit` (and `order`) constant.", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "Page size. Default 10, max 250.", "type": "text/plain" }, "key": "limit", "value": "10" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "usage", "description": "", "item": [ { "id": "66b3c33a-56db-4149-971c-7cb636bd297a", "name": "Current calendar-month credit usage", "request": { "name": "Current calendar-month credit usage", "description": { "content": "Cost 0. Foreplay `UsagesResponse` keys at the **top level**\n(`start_date`, `end_date`, `total_credits`, `remaining_credits`,\n`user:{id,email}`) plus the envelope superset. UTC calendar month.\nSystem key: `user: {id:\"system\", email:null}`. Missing `account`\nscope → 403. Additive `payment.spend` reports the presenting key's\nx402 spend ceiling (`limit_usd_cents` / `window_days` null when\nunlimited). Credits remain free and are never challenged.\n\n**Credits:** free.\n", "type": "text/plain" }, "url": { "path": [ "api", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e63dc7bd-b513-4ade-b8ab-b850ed54f4a0", "name": "Current month usage.", "originalRequest": { "url": { "path": [ "api", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"total_credits\": \"\",\n \"remaining_credits\": \"\",\n \"user\": {\n \"id\": \"\",\n \"email\": \"\"\n },\n \"payment\": {\n \"spend\": {\n \"limit_usd_cents\": \"\",\n \"window_days\": \"\",\n \"spent_usd_cents\": \"\",\n \"remaining_usd_cents\": \"\"\n }\n },\n \"data\": \"\",\n \"metadata\": {\n \"success\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\",\n \"cursor\": \"\",\n \"count\": \"\",\n \"total_found\": \"\",\n \"filters\": \"\",\n \"order\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71d13694-5def-45ad-ae5e-b5adf0b2a898", "name": "Missing or unknown API key.", "originalRequest": { "url": { "path": [ "api", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f733558b-f0e0-4b4a-9aa4-284e898b30dc", "name": "Out of credits. Only when `PUBLIC_API_ENFORCE_CREDITS=true` (default off).", "originalRequest": { "url": { "path": [ "api", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dc25650-2057-444f-85e5-1f91c19d7fa4", "name": "Revoked / expired key, missing scope, personal-key-required, or untracked spyder brand.", "originalRequest": { "url": { "path": [ "api", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dd90a2c-068b-4f59-b67f-30802d5c309b", "name": "Validation error (missing required param, invalid cursor, bad date window).", "originalRequest": { "url": { "path": [ "api", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab5fdf37-7b3f-4f29-b6a1-ca87b54a0a03", "name": "Rate limit exceeded (60 requests / 60 seconds).", "originalRequest": { "url": { "path": [ "api", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd16f701-54b1-4b3a-b6a6-64b66ce4c68a", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "api", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Trace-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Process-Time", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credits-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Credit-Cost", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": \"\",\n \"message\": \"\",\n \"status_code\": \"\",\n \"processed_at\": \"\"\n },\n \"error\": {\n \"message\": \"\"\n },\n \"data\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "payments", "description": "", "item": [ { "name": "Fetch a signed receipt for an owned settled payment", "request": { "name": "Fetch a signed receipt for an owned settled payment", "description": { "content": "Own settled PaymentTransaction rows only. Scope `account`. Credits: free. Cross-tenant → 404. Keyless is inline-only. Verify JWT against https://cypherapp.io/developers/receipt-public-key.pem.\n", "type": "text/plain" }, "url": { "path": [ "api", "payments", ":txId", "receipt" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "key": "txId", "value": "" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [] } ] } ] }, { "name": "x402 (exhausted key)", "description": "Payable 402 challenge vs pay-and-retry on GET /api/discovery/ads. Rail is dark in production until X402_ENABLED=true. On 402 with PAYMENT-REQUIRED, pay-and-retry once only within the user's stated budget; never auto-pay unbounded. A 402 without PAYMENT-REQUIRED (Out of credits / duplicate_settlement) is not payable.", "item": [ { "name": "x402 challenge (exhausted key)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "path": ["api", "discovery", "ads"], "host": ["{{baseUrl}}"], "query": [ { "key": "query", "value": "running shoes" }, { "key": "limit", "value": "5" } ] }, "description": { "content": "Exhausted keyed caller when the x402 rail is mounted. Expect HTTP 402, Foreplay envelope with an additive Payment required message, and a standard base64 PAYMENT-REQUIRED header (x402 v2, accepts[0].scheme === exact).", "type": "text/plain" } }, "response": [ { "name": "402 PAYMENT-REQUIRED challenge", "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "PAYMENT-REQUIRED", "value": "" } ], "body": "{\n \"metadata\": {\n \"success\": false,\n \"message\": \"Payment required: $0.01 for up to 5 items. See PAYMENT-REQUIRED header or https://cypherapp.io/developers#x402\",\n \"status_code\": 402,\n \"processed_at\": 0\n },\n \"error\": {\n \"message\": \"Payment required: $0.01 for up to 5 items. See PAYMENT-REQUIRED header or https://cypherapp.io/developers#x402\"\n },\n \"data\": []\n}" } ] }, { "name": "x402 pay-and-retry", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "PAYMENT-SIGNATURE", "value": "" } ], "url": { "path": ["api", "discovery", "ads"], "host": ["{{baseUrl}}"], "query": [ { "key": "query", "value": "running shoes" }, { "key": "limit", "value": "5" } ] }, "description": { "content": "Retry the same request after paying the quoted amount, only if it is within the user's stated budget. Never auto-pay unbounded. A successful x402-paid 2xx includes PAYMENT-RESPONSE and bills 0 credits.", "type": "text/plain" } }, "response": [ { "name": "200 PAYMENT-RESPONSE", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "PAYMENT-RESPONSE", "value": "" }, { "key": "X-Credit-Cost", "value": "0" } ], "body": "{\n \"data\": [],\n \"metadata\": {\n \"success\": true,\n \"status_code\": 200,\n \"processed_at\": 0,\n \"count\": 0\n }\n}" } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://cypherapp.io" }, { "key": "apiKey", "value": "" } ], "info": { "_postman_id": "32057cf7-1dcb-40b1-8bc5-2884ea3f94e6", "name": "Cypher Public API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "## Introduction\n\nCypher is a competitive ad-intelligence API for searching ads and brands,\nanalyzing creative patterns, and reading your saved library. The REST\ncontract below is the public keyed surface; private session and admin\nroutes are intentionally excluded.\n\n## Base URL\n\nProduction requests use `https://cypherapp.io`. The downloadable OpenAPI\ndocument and the explorer both default to that origin.\n\n## Authentication\n\nPresent a secret in **one header**. Query-string keys (`?api_key=`,\n`?token=`, `?secret=`) are rejected.\n\nAccepted presentations (first match wins):\n\n1. `x-secret-token: cypher_sk_…`\n2. `Authorization: Bearer cypher_sk_…`\n3. `Authorization: cypher_sk_…` (scheme-less, Foreplay-style)\n4. `x-api-key: cypher_sk_…` (or the system key)\n\nMint a personal `cypher_sk_` key from\n[API keys and MCP setup](/api-mcp). Never commit a real key or paste one\ninto a URL.\n\n## API keys and scopes\n\nThree secret kinds are accepted:\n\n- Hashed `ApiKey` rows (`cypher_sk_` prefix). Scopes and monthly credits\n come from the row. Revoked → 403 `\"API key has been revoked\"`. Expired →\n 403 `\"API key has expired\"`.\n- Legacy `User.apiSecretToken` (`cypher_sk_`). Default scopes\n `discovery` + `library` + `account`. No expiry.\n- `ADS_SYSTEM_API_KEY`. Scopes `discovery` + `account` only — **no\n `library`**, no bound user. Usage rows use the shared `system-key`\n bucket; `/api/usage` represents that bucket as `user.id = \"system\"`.\n\nSwipefile, Boards, and Spyder require a personal key bound to a user and\nthe `library` scope. A system key (or any key without `library`) gets 403\n`\"This endpoint requires a personal API key\"` or `\"Missing required scope:\nlibrary\"`.\n\n`x-required-scope` is the campaign contract (`discovery` / `library` /\n`account`). Discovery and analysis operations authenticate but do not\ncurrently call `hasScope(discovery)`; do not treat a missing 403 as a spec\nbug.\n\n## First search in 90 seconds\n\nCheck the current UTC month's balance before searching:\n\n```bash\ncurl -s https://cypherapp.io/api/usage \\\n -H \"Authorization: Bearer cypher_sk_YOUR_KEY\"\n```\n\nThen keep the first result set small. A successful response contains\n`data` and `metadata`; failures also include `error.message`.\n\n```bash\ncurl -s \"https://cypherapp.io/api/discovery/ads?query=running%20shoes&limit=5\" \\\n -H \"Authorization: Bearer cypher_sk_YOUR_KEY\"\n```\n\nRead `X-Credits-Remaining` and `X-Credit-Cost` after keyed responses and\nrender every ad's `cypher_url` as a link.\n\n## Competitor teardown\n\nResolve a domain, pull ads and analytics, then expand duplicates of a\nwinning creative:\n\n```bash\ncurl -s \"https://cypherapp.io/api/brand/getBrandsByDomain?domain=example.com\" \\\n -H \"Authorization: Bearer cypher_sk_YOUR_KEY\"\n\ncurl -s \"https://cypherapp.io/api/brand/getAdsByBrandId?brand_ids=BRAND_CUID&limit=20\" \\\n -H \"Authorization: Bearer cypher_sk_YOUR_KEY\"\n\ncurl -s \"https://cypherapp.io/api/brand/analytics?id=BRAND_CUID\" \\\n -H \"Authorization: Bearer cypher_sk_YOUR_KEY\"\n\ncurl -s \"https://cypherapp.io/api/ad/duplicates/{adId}\" \\\n -H \"Authorization: Bearer cypher_sk_YOUR_KEY\"\n```\n\n`GET /api/brand/getAdsByPageId?page_id=…` is the page-id alternative.\n`collect` is accepted and ignored; there is no on-demand scrape. Hold\n`limit` and `order` constant while paging.\n\n## Your library over MCP\n\nA **personal** key is required for Swipefile, Boards, and Spyder. Hosted\nMCP exposes the same library helpers over Streamable HTTP:\n\n```bash\nclaude mcp add --transport http cypher https://cypherapp.io/api/mcp\n```\n\nMCP is JSON-RPC, not a REST path in this document. REST fallbacks remain\navailable with the same personal key:\n\n```bash\ncurl -s \"https://cypherapp.io/api/swipefile/ads?limit=10\" \\\n -H \"Authorization: Bearer cypher_sk_YOUR_KEY\"\n\ncurl -s https://cypherapp.io/api/boards \\\n -H \"Authorization: Bearer cypher_sk_YOUR_KEY\"\n\ncurl -s https://cypherapp.io/api/spyder/brands \\\n -H \"Authorization: Bearer cypher_sk_YOUR_KEY\"\n```\n\n## Credits\n\nSee `X-Credits-Remaining` / `X-Credit-Cost`:\n\n| Class | Cost |\n| --- | --- |\n| Ad list (`ad-list`) | 1 per ad returned |\n| Brand list (`brand-list`) | 1 per brand returned |\n| Ad lookup (`ad-lookup`) | 1 if an ad is found, else 0 |\n| Flat listing (`flat-listing`) | 1 if the payload is non-empty, else 0 |\n| Account (`/api/usage`) | free |\n\n`PUBLIC_API_ENFORCE_CREDITS=true` turns a zero remaining balance into 402\n`\"Out of credits\"` before the handler runs. Default is off, but usage is\nstill recorded. A 200 response is not an unlimited month. Credit headers\nare omitted when the remaining-credits read fails and on unauthenticated\n401/403 responses.\n\n## Pagination\n\nHold `limit` and `order` constant across cursor pages.\nA cursor encodes its order, so reusing it with a different `order` is\n422. Offset endpoints use `offset` + `limit` instead.\n\n## Errors\n\nErrors use the public envelope with `metadata.success: false`, an\n`error.message`, and `data: []`. Client-fixable problems are 4xx. On 5xx,\nsurface `X-Trace-ID`; Cloudflare can replace the JSON body.\n\nCommon statuses are 401 invalid/missing key, 402 out of credits, 403\nrevoked/expired/insufficient scope, 404 unknown resource, 422 invalid\ninput or cursor, 429 rate limited, and 500 internal error.\n\n## Rate limits\n\nThe limit is 60 requests per 60 seconds per key. Read `X-RateLimit-*` and\nhonor `Retry-After` on 429.\n\n## Media and cypher_url\n\nEvery public Ad DTO includes a `cypher_url` pointing at the Discovery UI.\nRender it as a **markdown link**; do not invent an alternate path.\n\n`thumbnail`, `video`, and `image` are source URLs. This API\nnever proxies media bytes.\n\n## MCP and CLI\n\nHosted MCP is `POST https://cypherapp.io/api/mcp` using Streamable HTTP\nand the same authentication headers. The CLI is `@cypherai/cli`, a thin\nHTTP client over the REST paths in this document. See the\n[Agent Skill](/skills/cypher-api/SKILL.md) for an agent-first operating\nguide.\n\n## Contract notes\n\nSession/admin UI routes, `/api/mcp`, OPTIONS preflight, and POST/DELETE on\n`/api/boards` are not REST operations in this public spec. Path templates\nuse the Next.js names `{adId}` and `{brandId}`. `x-cypher-extension: true`\nmarks the four Cypher-only compatibility paths.\n", "type": "text/plain" } } }