{ "item": [ { "id": "faf67810-11fa-405a-b8ee-3892ef0c99ec", "name": "AI Chat", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "a231253f-5009-4ed4-8325-cbafb8ef20dc", "name": "Run Agent", "request": { "name": "Run Agent", "description": { "content": "Starts an asynchronous agent run. Returns immediately with `status: processing` and a `runId` that\nidentifies the run. Poll `GET /api/public/ai-chat/agent-runs/{runId}/status` until the run is\n`done` or `failed`.\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "ai-chat", "agents", ":agentId", "runs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "agentId", "description": "(Required) ID of an existing AI Chat agent. Copy it from the agent details page in the app." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8e1df97c-f2d7-4c84-9f30-e3bab0203efd", "name": "Agent run accepted", "originalRequest": { "url": { "path": [ "api", "public", "ai-chat", "agents", ":agentId", "runs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "agentId", "description": "(Required) ID of an existing AI Chat agent. Copy it from the agent details page in the app." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"runId\": 8931,\n \"status\": \"processing\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "226ba797-1017-4ee4-90c9-5eafd40694ef", "name": "Invalid request data", "originalRequest": { "url": { "path": [ "api", "public", "ai-chat", "agents", ":agentId", "runs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "agentId", "description": "(Required) ID of an existing AI Chat agent. Copy it from the agent details page in the app." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8cbd4151-50be-4d2e-aeb9-166ac7c11989", "name": "Invalid token, insufficient permissions, or agent is not active", "originalRequest": { "url": { "path": [ "api", "public", "ai-chat", "agents", ":agentId", "runs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "agentId", "description": "(Required) ID of an existing AI Chat agent. Copy it from the agent details page in the app." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a26f89dd-b5da-4e25-8f72-0db21f69e88b", "name": "Agent not found", "originalRequest": { "url": { "path": [ "api", "public", "ai-chat", "agents", ":agentId", "runs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "agentId", "description": "(Required) ID of an existing AI Chat agent. Copy it from the agent details page in the app." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb80a4fd-6400-4f99-9c5f-b436edbb01ae", "name": "Too many of your runs are in progress, or the monthly request limit is reached", "originalRequest": { "url": { "path": [ "api", "public", "ai-chat", "agents", ":agentId", "runs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "agentId", "description": "(Required) ID of an existing AI Chat agent. Copy it from the agent details page in the app." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f4f0eeee-870c-4fd2-a078-0dbf58c6e74a", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "public", "ai-chat", "agents", ":agentId", "runs" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "agentId", "description": "(Required) ID of an existing AI Chat agent. Copy it from the agent details page in the app." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"key_0\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e19d6ddb-9b1e-4d8b-a303-6647b5aca512", "name": "Get Agent Run Status", "request": { "name": "Get Agent Run Status", "description": { "content": "Returns the current status of an agent run started via\n`POST /api/public/ai-chat/agents/{agentId}/runs`. When `status` is `done`, `output` contains the\nassistant response text and `files` contains any downloadable files created by the run. Download URLs\nare short-lived; call this endpoint again if a URL expires. When `status` is `failed`, `error`\ndescribes the failure.\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "ai-chat", "agent-runs", ":runId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "runId", "description": "(Required) Run ID returned by `POST /api/public/ai-chat/agents/{agentId}/runs`." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "48f70b44-6c25-4357-8cef-ed19d03808bd", "name": "Agent run status", "originalRequest": { "url": { "path": [ "api", "public", "ai-chat", "agent-runs", ":runId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "runId", "description": "(Required) Run ID returned by `POST /api/public/ai-chat/agents/{agentId}/runs`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"runId\": 1067,\n \"status\": \"processing\",\n \"output\": \"string\",\n \"files\": [\n {\n \"fileId\": \"string\",\n \"fileName\": \"string\",\n \"fileType\": \"html\",\n \"size\": 7615,\n \"downloadUrl\": \"https://HzHtlhCSHvQkKENRtJsVHrfXyYZXx.vqdgPRSr2QBo\"\n },\n {\n \"fileId\": \"string\",\n \"fileName\": \"string\",\n \"fileType\": \"html\",\n \"size\": 1744,\n \"downloadUrl\": \"https://NpeOG.qisSIUYEX\"\n }\n ],\n \"error\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21b74092-cc88-4a0a-a2ad-b1237b38d7a4", "name": "Invalid request data", "originalRequest": { "url": { "path": [ "api", "public", "ai-chat", "agent-runs", ":runId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "runId", "description": "(Required) Run ID returned by `POST /api/public/ai-chat/agents/{agentId}/runs`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a3f0843-681f-4973-992d-f08704c67f8a", "name": "Invalid token or insufficient permissions", "originalRequest": { "url": { "path": [ "api", "public", "ai-chat", "agent-runs", ":runId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "runId", "description": "(Required) Run ID returned by `POST /api/public/ai-chat/agents/{agentId}/runs`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81ab3344-75cd-41df-b88c-d0dbc44e5ebf", "name": "Agent run not found", "originalRequest": { "url": { "path": [ "api", "public", "ai-chat", "agent-runs", ":runId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "runId", "description": "(Required) Run ID returned by `POST /api/public/ai-chat/agents/{agentId}/runs`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c6575d74-8721-4724-b0d1-16c97f45e7cf", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "public", "ai-chat", "agent-runs", ":runId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "8950", "key": "runId", "description": "(Required) Run ID returned by `POST /api/public/ai-chat/agents/{agentId}/runs`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8112a752-cc3e-49ac-99f3-90a27a5282b7", "name": "Campaigns", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f6200dac-e1b5-431c-8946-dc77028ffe75", "name": "Create Campaign", "request": { "name": "Create Campaign", "description": { "content": "Creates one campaign for each flight in the request.", "type": "text/plain" }, "url": { "path": [ "api", "public", "campaign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"advertiser\": \"string\",\n \"type\": \"story\",\n \"flights\": [\n {\n \"startDate\": \"2021-09-05T19:42:37.890Z\",\n \"endDate\": \"1994-11-27T19:10:44.168Z\",\n \"expectedDate\": \"2019-07-29T02:10:41.719Z\",\n \"totalCost\": 1044.6500253659897,\n \"cpm\": 9257.713518515679,\n \"currency\": \"USD\",\n \"expectedImpressions\": 3281.549128253245\n },\n {\n \"startDate\": \"1969-12-01T22:49:54.949Z\",\n \"endDate\": \"1992-06-22T20:27:41.957Z\",\n \"expectedDate\": \"2006-10-30T04:26:16.427Z\",\n \"totalCost\": 3142.974112216701,\n \"cpm\": 9042.187468031872,\n \"currency\": \"USD\",\n \"expectedImpressions\": 2167.2191435242394\n }\n ],\n \"publisher\": \"string\",\n \"externalId\": \"string\",\n \"itunesOrYtId\": \"string\",\n \"geo\": \"GLOBAL\",\n \"expectedUnits\": [\n {\n \"position\": \"pre\",\n \"length\": 4810.381390279929\n },\n {\n \"position\": \"feed drop\",\n \"length\": 2695.5736160520005\n }\n ],\n \"promo\": \"string\",\n \"expectedLandingUrl\": \"http://FkMOJVSrhEamFNBqKRcMAKQvyC.rjhlKxt.co2PZ7GKjH4Fn3tTnIPo3OAkpB1u1B,MTaGkfmNuUXFrBXMwHq\",\n \"product\": \"string\",\n \"initiative\": \"string\",\n \"expectedTalkingPoints\": [\n \"string\",\n \"string\"\n ],\n \"disallowedTalkingPoints\": [\n \"string\",\n \"string\"\n ],\n \"mediaType\": \"podcast\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"scriptUrl\": \"http://SnmePcn.nrI4H2v4Sb4bObimP,rB9iTNG9jMd5wdd5jw1Y1q\",\n \"teamMembers\": [\n \"string\",\n \"string\"\n ],\n \"creativeIds\": [\n \"string\",\n \"string\"\n ],\n \"billToPublisher\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7582ef3c-184d-46b2-9a2b-b8f30bab69e3", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "campaign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"advertiser\": \"string\",\n \"type\": \"Baked-in\",\n \"flights\": [\n {\n \"startDate\": \"1970-05-25T04:20:22.552Z\",\n \"endDate\": \"1950-08-29T16:01:33.741Z\",\n \"expectedDate\": \"1967-07-07T14:18:38.863Z\",\n \"totalCost\": 3601.6981373366707,\n \"cpm\": 4850.565990576881,\n \"currency\": \"USD\",\n \"expectedImpressions\": 7185.310419602\n },\n {\n \"startDate\": \"1961-07-18T09:56:28.828Z\",\n \"endDate\": \"1980-04-15T13:43:32.403Z\",\n \"expectedDate\": \"1996-11-08T19:32:52.481Z\",\n \"totalCost\": 4467.932416051099,\n \"cpm\": 499.04468233780364,\n \"currency\": \"USD\",\n \"expectedImpressions\": 6127.5935960813285\n }\n ],\n \"publisher\": \"string\",\n \"externalId\": \"string\",\n \"itunesOrYtId\": \"string\",\n \"geo\": \"GLOBAL\",\n \"expectedUnits\": [\n {\n \"position\": \"mid\",\n \"length\": 5573.464458190342\n },\n {\n \"position\": \"feed drop\",\n \"length\": 119.6430846599439\n }\n ],\n \"promo\": \"string\",\n \"expectedLandingUrl\": \"https://uVsUNFXiRxwcZpNccvItPJOvedgQFVy.ejJa0w9z.A-Ss+L,ASEf6uxz5RW+vRnBhVTrbEXMniu3S4V+Botyft6StJNlBxztw+z9ZTULFTD8UnQCpb9j,MJb\",\n \"product\": \"string\",\n \"initiative\": \"string\",\n \"expectedTalkingPoints\": [\n \"string\",\n \"string\"\n ],\n \"disallowedTalkingPoints\": [\n \"string\",\n \"string\"\n ],\n \"mediaType\": \"podcast\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"scriptUrl\": \"https://eHkuc.puNwEeplom+JYfw.VmnuG,UfSx87kUIrjiCDwBKvoKhd\",\n \"teamMembers\": [\n \"string\",\n \"string\"\n ],\n \"creativeIds\": [\n \"string\",\n \"string\"\n ],\n \"billToPublisher\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"campaigns\": [\n {\n \"id\": \"3862fa03-d287-a23c-b0c3-1c2ac841c8fd\",\n \"externalId\": \"string\"\n },\n {\n \"id\": \"6cb14770-e72c-2ead-79c3-8c684155e594\",\n \"externalId\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69dc96eb-4dce-4004-a299-68b83d5f97d2", "name": "The show or publisher was not found, the publisher could not be inferred from the show, the flights are not valid for the campaign type (including a feed drop combined with another position), or the advertiser name is unknown for an advertiser login or a limited account.", "originalRequest": { "url": { "path": [ "api", "public", "campaign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"advertiser\": \"string\",\n \"type\": \"Baked-in\",\n \"flights\": [\n {\n \"startDate\": \"1970-05-25T04:20:22.552Z\",\n \"endDate\": \"1950-08-29T16:01:33.741Z\",\n \"expectedDate\": \"1967-07-07T14:18:38.863Z\",\n \"totalCost\": 3601.6981373366707,\n \"cpm\": 4850.565990576881,\n \"currency\": \"USD\",\n \"expectedImpressions\": 7185.310419602\n },\n {\n \"startDate\": \"1961-07-18T09:56:28.828Z\",\n \"endDate\": \"1980-04-15T13:43:32.403Z\",\n \"expectedDate\": \"1996-11-08T19:32:52.481Z\",\n \"totalCost\": 4467.932416051099,\n \"cpm\": 499.04468233780364,\n \"currency\": \"USD\",\n \"expectedImpressions\": 6127.5935960813285\n }\n ],\n \"publisher\": \"string\",\n \"externalId\": \"string\",\n \"itunesOrYtId\": \"string\",\n \"geo\": \"GLOBAL\",\n \"expectedUnits\": [\n {\n \"position\": \"mid\",\n \"length\": 5573.464458190342\n },\n {\n \"position\": \"feed drop\",\n \"length\": 119.6430846599439\n }\n ],\n \"promo\": \"string\",\n \"expectedLandingUrl\": \"https://uVsUNFXiRxwcZpNccvItPJOvedgQFVy.ejJa0w9z.A-Ss+L,ASEf6uxz5RW+vRnBhVTrbEXMniu3S4V+Botyft6StJNlBxztw+z9ZTULFTD8UnQCpb9j,MJb\",\n \"product\": \"string\",\n \"initiative\": \"string\",\n \"expectedTalkingPoints\": [\n \"string\",\n \"string\"\n ],\n \"disallowedTalkingPoints\": [\n \"string\",\n \"string\"\n ],\n \"mediaType\": \"podcast\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"scriptUrl\": \"https://eHkuc.puNwEeplom+JYfw.VmnuG,UfSx87kUIrjiCDwBKvoKhd\",\n \"teamMembers\": [\n \"string\",\n \"string\"\n ],\n \"creativeIds\": [\n \"string\",\n \"string\"\n ],\n \"billToPublisher\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd80f9a6-b0fd-44c7-9964-7fc26624aeaa", "name": "The account cannot create campaigns, cannot create a campaign for this advertiser, has no main publisher account for billing, or the show or SmartPromo is not assigned to this podcaster login.", "originalRequest": { "url": { "path": [ "api", "public", "campaign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"advertiser\": \"string\",\n \"type\": \"Baked-in\",\n \"flights\": [\n {\n \"startDate\": \"1970-05-25T04:20:22.552Z\",\n \"endDate\": \"1950-08-29T16:01:33.741Z\",\n \"expectedDate\": \"1967-07-07T14:18:38.863Z\",\n \"totalCost\": 3601.6981373366707,\n \"cpm\": 4850.565990576881,\n \"currency\": \"USD\",\n \"expectedImpressions\": 7185.310419602\n },\n {\n \"startDate\": \"1961-07-18T09:56:28.828Z\",\n \"endDate\": \"1980-04-15T13:43:32.403Z\",\n \"expectedDate\": \"1996-11-08T19:32:52.481Z\",\n \"totalCost\": 4467.932416051099,\n \"cpm\": 499.04468233780364,\n \"currency\": \"USD\",\n \"expectedImpressions\": 6127.5935960813285\n }\n ],\n \"publisher\": \"string\",\n \"externalId\": \"string\",\n \"itunesOrYtId\": \"string\",\n \"geo\": \"GLOBAL\",\n \"expectedUnits\": [\n {\n \"position\": \"mid\",\n \"length\": 5573.464458190342\n },\n {\n \"position\": \"feed drop\",\n \"length\": 119.6430846599439\n }\n ],\n \"promo\": \"string\",\n \"expectedLandingUrl\": \"https://uVsUNFXiRxwcZpNccvItPJOvedgQFVy.ejJa0w9z.A-Ss+L,ASEf6uxz5RW+vRnBhVTrbEXMniu3S4V+Botyft6StJNlBxztw+z9ZTULFTD8UnQCpb9j,MJb\",\n \"product\": \"string\",\n \"initiative\": \"string\",\n \"expectedTalkingPoints\": [\n \"string\",\n \"string\"\n ],\n \"disallowedTalkingPoints\": [\n \"string\",\n \"string\"\n ],\n \"mediaType\": \"podcast\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"scriptUrl\": \"https://eHkuc.puNwEeplom+JYfw.VmnuG,UfSx87kUIrjiCDwBKvoKhd\",\n \"teamMembers\": [\n \"string\",\n \"string\"\n ],\n \"creativeIds\": [\n \"string\",\n \"string\"\n ],\n \"billToPublisher\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0db8cd3c-e9cb-419b-8f72-44654b34e3a2", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "campaign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"advertiser\": \"string\",\n \"type\": \"Baked-in\",\n \"flights\": [\n {\n \"startDate\": \"1970-05-25T04:20:22.552Z\",\n \"endDate\": \"1950-08-29T16:01:33.741Z\",\n \"expectedDate\": \"1967-07-07T14:18:38.863Z\",\n \"totalCost\": 3601.6981373366707,\n \"cpm\": 4850.565990576881,\n \"currency\": \"USD\",\n \"expectedImpressions\": 7185.310419602\n },\n {\n \"startDate\": \"1961-07-18T09:56:28.828Z\",\n \"endDate\": \"1980-04-15T13:43:32.403Z\",\n \"expectedDate\": \"1996-11-08T19:32:52.481Z\",\n \"totalCost\": 4467.932416051099,\n \"cpm\": 499.04468233780364,\n \"currency\": \"USD\",\n \"expectedImpressions\": 6127.5935960813285\n }\n ],\n \"publisher\": \"string\",\n \"externalId\": \"string\",\n \"itunesOrYtId\": \"string\",\n \"geo\": \"GLOBAL\",\n \"expectedUnits\": [\n {\n \"position\": \"mid\",\n \"length\": 5573.464458190342\n },\n {\n \"position\": \"feed drop\",\n \"length\": 119.6430846599439\n }\n ],\n \"promo\": \"string\",\n \"expectedLandingUrl\": \"https://uVsUNFXiRxwcZpNccvItPJOvedgQFVy.ejJa0w9z.A-Ss+L,ASEf6uxz5RW+vRnBhVTrbEXMniu3S4V+Botyft6StJNlBxztw+z9ZTULFTD8UnQCpb9j,MJb\",\n \"product\": \"string\",\n \"initiative\": \"string\",\n \"expectedTalkingPoints\": [\n \"string\",\n \"string\"\n ],\n \"disallowedTalkingPoints\": [\n \"string\",\n \"string\"\n ],\n \"mediaType\": \"podcast\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"scriptUrl\": \"https://eHkuc.puNwEeplom+JYfw.VmnuG,UfSx87kUIrjiCDwBKvoKhd\",\n \"teamMembers\": [\n \"string\",\n \"string\"\n ],\n \"creativeIds\": [\n \"string\",\n \"string\"\n ],\n \"billToPublisher\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ed5ea3c-947d-4276-9d34-a9556a7e8df1", "name": "Update Campaign", "request": { "name": "Update Campaign", "description": { "content": "Updates a campaign's dates, cost, units and other details.", "type": "text/plain" }, "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f", "key": "request_id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"story\",\n \"startDate\": \"1994-10-20T21:46:18.233Z\",\n \"endDate\": \"1970-09-12T14:40:20.754Z\",\n \"expectedDate\": \"1962-08-13T03:35:45.962Z\",\n \"totalCost\": 3467.923045132275,\n \"cpm\": 8129.118466136622,\n \"currency\": \"EUR\",\n \"expectedImpressions\": 8143.010621942682,\n \"itunesOrYtId\": \"string\",\n \"geo\": \"JP\",\n \"expectedUnits\": [\n [\n {\n \"position\": \"post\",\n \"length\": 666.8952430912323\n },\n {\n \"position\": \"feed drop\",\n \"length\": 535.0966088335829\n }\n ],\n [\n {\n \"position\": \"post\",\n \"length\": 9050.350459870562\n },\n {\n \"position\": \"post\",\n \"length\": 326.013983611777\n }\n ]\n ],\n \"promo\": \"string\",\n \"expectedLandingUrl\": \"http://PU.byxXvmMV5Yf2JBaCFe.P+kTSP,Pd-PBB0SOS+,LUo1.+07xLryUdyZ8\",\n \"product\": \"string\",\n \"initiative\": \"string\",\n \"mediaType\": \"spotify\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"teamMembers\": [\n \"string\",\n \"string\"\n ],\n \"creativeIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d934a8d0-0835-4ef0-8687-7209c4b8eef6", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f", "key": "request_id", "description": "(Required) Campaign ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"type\": \"Baked-in\",\n \"startDate\": \"2015-10-29T03:41:06.261Z\",\n \"endDate\": \"1961-08-31T14:30:13.167Z\",\n \"expectedDate\": \"1951-09-18T05:58:42.781Z\",\n \"totalCost\": 5259.578851708884,\n \"cpm\": 9004.287257757554,\n \"currency\": \"EUR\",\n \"expectedImpressions\": 9558.755320396122,\n \"itunesOrYtId\": \"string\",\n \"geo\": \"AT\",\n \"expectedUnits\": [\n [\n {\n \"position\": \"feed drop\",\n \"length\": 5513.380812424267\n },\n {\n \"position\": \"post\",\n \"length\": 4381.488992397793\n }\n ],\n [\n {\n \"position\": \"pre\",\n \"length\": 4493.776686403519\n },\n {\n \"position\": \"mid\",\n \"length\": 2285.5409784505086\n }\n ]\n ],\n \"promo\": \"string\",\n \"expectedLandingUrl\": \"https://nCICqKjdFkYHNNuhKE.duobsKGH5LXL0ivTsJbYGKWKSYQEFFlmU\",\n \"product\": \"string\",\n \"initiative\": \"string\",\n \"mediaType\": \"instagram\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"teamMembers\": [\n \"string\",\n \"string\"\n ],\n \"creativeIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "faf37f62-ed62-4a8b-9399-dd1f6839c604", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f", "key": "request_id", "description": "(Required) Campaign ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"type\": \"Baked-in\",\n \"startDate\": \"2015-10-29T03:41:06.261Z\",\n \"endDate\": \"1961-08-31T14:30:13.167Z\",\n \"expectedDate\": \"1951-09-18T05:58:42.781Z\",\n \"totalCost\": 5259.578851708884,\n \"cpm\": 9004.287257757554,\n \"currency\": \"EUR\",\n \"expectedImpressions\": 9558.755320396122,\n \"itunesOrYtId\": \"string\",\n \"geo\": \"AT\",\n \"expectedUnits\": [\n [\n {\n \"position\": \"feed drop\",\n \"length\": 5513.380812424267\n },\n {\n \"position\": \"post\",\n \"length\": 4381.488992397793\n }\n ],\n [\n {\n \"position\": \"pre\",\n \"length\": 4493.776686403519\n },\n {\n \"position\": \"mid\",\n \"length\": 2285.5409784505086\n }\n ]\n ],\n \"promo\": \"string\",\n \"expectedLandingUrl\": \"https://nCICqKjdFkYHNNuhKE.duobsKGH5LXL0ivTsJbYGKWKSYQEFFlmU\",\n \"product\": \"string\",\n \"initiative\": \"string\",\n \"mediaType\": \"instagram\",\n \"tags\": [\n \"string\",\n \"string\"\n ],\n \"teamMembers\": [\n \"string\",\n \"string\"\n ],\n \"creativeIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7426a0c4-2a80-4d9d-a84d-301a641bd9af", "name": "Delete Campaign", "request": { "name": "Delete Campaign", "description": { "content": "Archives a campaign.", "type": "text/plain" }, "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f", "key": "request_id", "description": "(Required) Campaign ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "35494bdf-917f-4a4a-996f-fc7f853f6f50", "name": "Delete success.", "originalRequest": { "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f", "key": "request_id", "description": "(Required) Campaign ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b8e927dc-3123-482b-846d-112172108af1", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f", "key": "request_id", "description": "(Required) Campaign ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e1520e83-03ac-4857-a1c0-88a7a3a6cc91", "name": "Campaign Reporting", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "3cb03755-ae08-441b-a735-6171c1ca49e5", "name": "Single Campaign", "request": { "name": "Single Campaign", "description": { "content": "**Note:** An organization-scoped API key returns a campaign only when it belongs to that key's advertiser and publisher. A campaign outside that scope is not found. Attribution numbers the agency hid from that publisher are omitted.\n\nDetails, ads, flags, delivery and site performance of one campaign.\n\nExample:\n\n```bash\ncurl -sS -G 'https://backend.podscribe.ai/api/public/campaign/{request_id}' \\\n --data-urlencode 'unique_ads_only=true' \\\n -H 'Authorization: Bearer ' \\\n -H 'Accept: application/json'\n```\n\nReplace `{request_id}` with the campaign ID or external ID. Omit `unique_ads_only` (or set `false`) to return all ads.", "type": "text/plain" }, "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "unique_ads_only", "value": "false", "description": "When true, returns only unique ads" }, { "disabled": false, "key": "include_episode_descriptions", "value": "false", "description": "When true, each ad in the response includes the source episode description" }, { "disabled": false, "key": "include_pinned_comments", "value": "false", "description": "When true, each ad in the response includes the pinned comment for the source episode (when available)" }, { "disabled": false, "key": "matched_promo_ads_only", "value": "false", "description": "When true, returns only ads whose promo matches the campaign promo (campaigns without promo keep all ads)" }, { "disabled": false, "key": "include_ad_transcripts", "value": "false", "description": "When true, each ad in the response includes the transcript text" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) Campaign ID or external ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "afbd5d9a-9870-4e85-b063-436713d3e611", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unique_ads_only", "value": "false" }, { "key": "include_episode_descriptions", "value": "false" }, { "key": "include_pinned_comments", "value": "false" }, { "key": "matched_promo_ads_only", "value": "false" }, { "key": "include_ad_transcripts", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) Campaign ID or external ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"externalId\": \"string\",\n \"requestId\": \"490ef4c3-8f04-55cd-a257-ee4a2da277f3\",\n \"endDate\": \"1959-08-09T03:31:44.416Z\",\n \"startDate\": \"1985-05-02T07:49:58.020Z\",\n \"expectedDate\": \"2000-08-29T01:46:53.712Z\",\n \"geo\": \"string\",\n \"expectedLengths\": [\n 7450,\n 6241\n ],\n \"expectedTypes\": [\n \"string\",\n \"string\"\n ],\n \"promo\": \"string\",\n \"category\": \"string\",\n \"agency\": \"string\",\n \"rate\": 2018.6643179341934,\n \"talkingPoints\": \"string\",\n \"expectedImpressions\": 4074.6201019966197,\n \"publisher\": \"string\",\n \"advertiser\": \"string\",\n \"placementName\": \"string\",\n \"prefixPlacedAt\": \"1966-06-21T00:54:54.430Z\",\n \"advertiserLookupName\": \"string\",\n \"seriesId\": 9512.625269191934,\n \"itunesId\": \"string\",\n \"youtubeSeriesId\": 3333.341605909699,\n \"spotifyVideoOptInDate\": \"1955-06-05T18:50:32.335Z\",\n \"name\": \"string\",\n \"isDai\": false\n },\n \"ads\": [\n {\n \"adId\": 2245.8110112406303,\n \"episodeTitle\": \"string\",\n \"episodeId\": 8766.47129668543,\n \"episodeDuration\": 6617.498046848338,\n \"showTitle\": \"string\",\n \"platform\": \"Spotify\",\n \"publisher\": \"string\",\n \"transcriptionCreatedAt\": \"1956-12-04T20:29:56.902Z\",\n \"audioFileUrl\": \"string\",\n \"transcriptFileUrl\": \"string\",\n \"startTs\": 9471.538964082687,\n \"endTs\": 1936.16574264726,\n \"episodeUrlInFeed\": \"string\",\n \"publicLink\": \"https://eMWHygeYfLwIjXOUNfJ.wpvyALOay.me9UNyuSx164qBQzJ..2d0ShvO9VR-Q\",\n \"placementNum\": 6301.266839614492,\n \"placementGroupNum\": 8458.963463034812,\n \"placementGroupInNum\": 2609.933700462934,\n \"placementPercent\": 8884.224135888817,\n \"competitors\": [\n \"string\",\n \"string\"\n ],\n \"advertisersBefore\": [\n \"string\",\n \"string\"\n ],\n \"advertisersAfter\": [\n \"string\",\n \"string\"\n ],\n \"transcriptText\": \"string\"\n },\n {\n \"adId\": 7766.678086475198,\n \"episodeTitle\": \"string\",\n \"episodeId\": 7322.6739206662005,\n \"episodeDuration\": 428.3187652452813,\n \"showTitle\": \"string\",\n \"platform\": \"Spotify\",\n \"publisher\": \"string\",\n \"transcriptionCreatedAt\": \"1963-06-14T17:37:02.453Z\",\n \"audioFileUrl\": \"string\",\n \"transcriptFileUrl\": \"string\",\n \"startTs\": 7908.772612207981,\n \"endTs\": 2405.478384046813,\n \"episodeUrlInFeed\": \"string\",\n \"publicLink\": \"https://RrXhgAPmGofwGZeQzWRcrgbpNGnfUNa.xhpEQdCZzdPR\",\n \"placementNum\": 2259.202999277261,\n \"placementGroupNum\": 430.8860093884581,\n \"placementGroupInNum\": 1951.2708137731183,\n \"placementPercent\": 5320.823331144715,\n \"competitors\": [\n \"string\",\n \"string\"\n ],\n \"advertisersBefore\": [\n \"string\",\n \"string\"\n ],\n \"advertisersAfter\": [\n \"string\",\n \"string\"\n ],\n \"transcriptText\": \"string\"\n }\n ],\n \"flags\": [\n {\n \"adId\": \"string\",\n \"flags\": \"string\",\n \"competitors\": [\n {\n \"competitor\": \"string\",\n \"publishedAt\": \"1947-04-15T05:15:13.870Z\",\n \"transcriptionCreatedAt\": \"1947-01-15T07:58:23.733Z\"\n },\n {\n \"competitor\": \"string\",\n \"publishedAt\": \"2021-10-12T13:39:26.883Z\",\n \"transcriptionCreatedAt\": \"1953-01-14T20:13:55.265Z\"\n }\n ]\n },\n {\n \"adId\": \"string\",\n \"flags\": \"string\",\n \"competitors\": [\n {\n \"competitor\": \"string\",\n \"publishedAt\": \"1952-08-12T07:49:57.307Z\",\n \"transcriptionCreatedAt\": \"2012-12-11T19:38:55.416Z\"\n },\n {\n \"competitor\": \"string\",\n \"publishedAt\": \"1987-07-19T20:34:55.130Z\",\n \"transcriptionCreatedAt\": \"1966-07-27T13:59:32.450Z\"\n }\n ]\n }\n ],\n \"flagsByAdId\": {\n \"key_0\": [\n \"string\",\n \"string\"\n ]\n },\n \"reporting\": {\n \"downloadsTotal\": 5413.926215352314,\n \"youtubeViewsTotal\": 8532.912551683467,\n \"downloadsByDay\": [\n {\n \"date\": \"string\",\n \"impressions\": 7250.259141234265\n },\n {\n \"date\": \"string\",\n \"impressions\": 926.0059195151715\n }\n ],\n \"youtubeViewsByDay\": [\n {\n \"date\": \"string\",\n \"views\": 3300.5883609901466\n },\n {\n \"date\": \"string\",\n \"views\": 9468.74856995346\n }\n ],\n \"instagramViewsTotal\": 426.6431850305041,\n \"instagramViewsByDay\": [\n {\n \"date\": \"1994-03-29\",\n \"views\": 937.7602672884188\n },\n {\n \"date\": \"1970-03-14\",\n \"views\": 6927.796853831931\n }\n ],\n \"instagramLikesTotal\": 2674.4553803913627,\n \"instagramLikesByDay\": [\n {\n \"date\": \"2008-08-19\",\n \"likes\": 557.6781461799496\n },\n {\n \"date\": \"1978-10-10\",\n \"likes\": 296.49494867769687\n }\n ],\n \"instagramCommentsTotal\": 9859.347837022495,\n \"instagramCommentsByDay\": [\n {\n \"date\": \"1962-11-30\",\n \"comments\": 4489.737887775931\n },\n {\n \"date\": \"1971-05-24\",\n \"comments\": 3185.266396214226\n }\n ],\n \"tiktokViewsTotal\": 745.2532295229996,\n \"tiktokViewsByDay\": [\n {\n \"date\": \"1975-05-04\",\n \"views\": 2818.789664189951\n },\n {\n \"date\": \"1962-09-16\",\n \"views\": 545.9699662901252\n }\n ],\n \"tiktokLikesTotal\": 2785.5999668902887,\n \"tiktokLikesByDay\": [\n {\n \"date\": \"1956-10-02\",\n \"likes\": 8741.88562496553\n },\n {\n \"date\": \"1971-09-18\",\n \"likes\": 8093.792709143486\n }\n ],\n \"tiktokCommentsTotal\": 6058.427966472519,\n \"tiktokCommentsByDay\": [\n {\n \"date\": \"1964-09-09\",\n \"comments\": 7231.4147855415185\n },\n {\n \"date\": \"1979-02-15\",\n \"comments\": 2479.57161409571\n }\n ],\n \"twitchViewsTotal\": 9832.633626350791,\n \"twitchViewsByDay\": [\n {\n \"date\": \"1972-05-04\",\n \"views\": 1850.171885142753\n },\n {\n \"date\": \"1976-04-17\",\n \"views\": 7746.371571772841\n }\n ],\n \"downloadsAndViewsByEpisodeByDay\": {\n \"key_0\": [\n {\n \"startDate\": \"string\",\n \"impressions\": 7837.979172082219,\n \"views\": 3725.5177822996943\n },\n {\n \"startDate\": \"string\",\n \"impressions\": 2901.462352604276,\n \"views\": 569.3482103488035\n }\n ],\n \"key_1\": [\n {\n \"startDate\": \"string\",\n \"impressions\": 8891.011437047862,\n \"views\": 3332.7114306120607\n },\n {\n \"startDate\": \"string\",\n \"impressions\": 7874.5727211108215,\n \"views\": 7525.764218341928\n }\n ]\n },\n \"reach\": 2496.9721304551726,\n \"frequency\": 4172.601289565103\n },\n \"performance\": {\n \"visitors\": 7408.715527121472,\n \"visits\": 4587.479183821308,\n \"signups\": 2379.0245346506645,\n \"purchases\": 6517.958656495979,\n \"leads\": 8073.160546722475,\n \"visitorsByDate\": {\n \"2025-07-29\": 175,\n \"2025-07-30\": 350\n },\n \"visitsByDate\": {\n \"2025-07-29\": 175,\n \"2025-07-30\": 350\n },\n \"signupsByDate\": {\n \"2025-07-29\": 175,\n \"2025-07-30\": 350\n },\n \"purchasesByDate\": {\n \"2025-07-29\": 175,\n \"2025-07-30\": 350\n },\n \"leadsByDate\": {\n \"2025-07-29\": 175,\n \"2025-07-30\": 350\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36f3e416-0196-4674-acee-4a972c82908f", "name": "Invalid token or no API access", "originalRequest": { "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unique_ads_only", "value": "false" }, { "key": "include_episode_descriptions", "value": "false" }, { "key": "include_pinned_comments", "value": "false" }, { "key": "matched_promo_ads_only", "value": "false" }, { "key": "include_ad_transcripts", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) Campaign ID or external ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3938e2c2-ec5a-4048-b49e-0e27cf720334", "name": "Campaign not found", "originalRequest": { "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unique_ads_only", "value": "false" }, { "key": "include_episode_descriptions", "value": "false" }, { "key": "include_pinned_comments", "value": "false" }, { "key": "matched_promo_ads_only", "value": "false" }, { "key": "include_ad_transcripts", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) Campaign ID or external ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "84c43e86-67e4-41cc-839d-6d3357622cb1", "name": "Monthly request limit exceeded", "originalRequest": { "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unique_ads_only", "value": "false" }, { "key": "include_episode_descriptions", "value": "false" }, { "key": "include_pinned_comments", "value": "false" }, { "key": "matched_promo_ads_only", "value": "false" }, { "key": "include_ad_transcripts", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) Campaign ID or external ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1d7e99e5-3c1f-4428-a15e-047554bca5a7", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "campaign", ":request_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "unique_ads_only", "value": "false" }, { "key": "include_episode_descriptions", "value": "false" }, { "key": "include_pinned_comments", "value": "false" }, { "key": "matched_promo_ads_only", "value": "false" }, { "key": "include_ad_transcripts", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "request_id", "description": "(Required) Campaign ID or external ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b864478-6f65-447a-bcf3-0ced7295f389", "name": "By Campaign", "request": { "name": "By Campaign", "description": { "content": "Impressions, reach, spend and conversions per campaign, show and episode by day, week or month, or per-campaign totals.\n\n\n> For the most accurate YouTube Engaged Views and attribution numbers, set `endDate` to at least 3 days before today. Numbers in the last 3 days may include estimates and can change once YouTube reports actual data.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|-----------------------|----------|-----------------------|----------------------------------------------------------------------------------------------------------|\n| Week | string | 2023-12-18 | Date of the week in the format YYYY-mm-DD. |\n| Day | string | 2023-12-23 | Date of the day in the format YYYY-mm-DD. |\n| Advertiser | string | demoAdvertiser | Name of the advertiser for the media content. |\n| Media Type | string | podcast | Type of media content, such as \"podcast,\" \"podcast and youtube,\" \"youtube,\" \"simulcast,\" or \"streaming.\" |\n| Type | string | baked-in | Type of ad integration, either \"baked-in\" or \"dai\" (Dynamic Ad Insertion). |\n| Tags | string | Retail | Optional tags associated with the campaign. |\n| Spend | number | 123 | Amount spent on the advertisement, if applicable. |\n| Publisher | string | Some publisher | Name of the publisher or platform hosting the content. |\n| Campaign | string | My Campaign | Name of the advertising campaign. |\n| Show | string | Some Show | Name of the show associated with the media content. |\n| Show ID | number | 123 | Podscribe ID of the show. Excluded by default except for previously enabled advertisers; request via `fields`. |\n| Episode | string | Some Ep | Name or identifier of the specific episode, if applicable. |\n| Publish Date | string | 2023-12-18 | Date when the media content was published, in the format YYYY-mm-DD. |\n| Podcast & Streaming Impressions| number | 123 | Number of podcast & streaming impressions, if applicable. |\n| Delivered Contracted Impressions | number | 123 | DAI impressions within flight dates, capped by expected impressions. Hidden by default; request via `fields`. |\n| YouTube Views | number | 123 | Number of views for YouTube content, if applicable. |\n| Reach | number | 123 | Reach represents the total number of unique users who saw the ad. |\n| Visitors | number | 123 | Number of visitors to a website, if applicable. |\n| Visits | number | 123 | Number of visits to a website, if applicable. |\n| Leads | number | 123 | Number of leads generated, if applicable. |\n| Installs | number | 123 | Number of app installations, if applicable. |\n| Signups | number | 123 | Number of signups or registrations, if applicable. |\n| Purchases | number | 123 | Number of purchases made, if applicable. |\n| | number | 123 | Count of an advertiser-defined custom event. Header is the action name (e.g. \"order_complete\"). Also included when `geoGrouping` is set. Mapped actions are excluded by default unless listed in `fields`. |\n| Revenue | number | 123 | Revenue generated, if applicable. |\n| Visitors Modeled | number | 123 | Modeled number of visitors based on data analysis, if applicable. |\n| Visits Modeled | number | 123 | Modeled number of visits based on data analysis, if applicable. |\n| Leads Modeled | number | 123 | Modeled number of leads based on data analysis, if applicable. |\n| Installs Modeled | number | 123 | Modeled number of app installations based on data analysis, if applicable. |\n| Signups Modeled | number | 123 | Modeled number of signups based on data analysis, if applicable. |\n| Purchases Modeled | number | 123 | Modeled number of purchases based on data analysis, if applicable. |\n| Revenue Modeled | number | 123 | Modeled revenue based on data analysis, if applicable. |\n| Modeled | number | 123 | Modeled count of the custom event. Header is \" Modeled\" (e.g. \"order_complete Modeled\"). Also included when `geoGrouping` is set. |\n| Promo codes | number | 123 | Number of times promo codes associated with the ad were used, if applicable. |\n| Clicks | number | 123 | How many times link was clicked. |\n| Campaign ID | string | some-campaign-id | Identifier for the advertising campaign. |\n| Campaign Internal ID | string | mycampaign | The campaign's identifier in Podscribe. |\n| Podscribe Campaign ID | string | 3105cc60-3970-11f1-a827-67ac2fdfebc6 | Unique Podscribe campaign request ID. |\n| Publisher ID | string | 123 | Podscribe publisher ID. |\n| Product | string | some-product | The product name. |\n| Initiative | string | some-initiative | The initiative name. |\n| Business Line | string | some-business-line | The business line name. |\n| Rumble Impressions | number | 123 | Number of Rumble impressions, if applicable. |\n| Spotify Video Impressions | number | 123 | Number of Spotify video impressions, if applicable. |\n| Episode GUID | string | episode-guid | Guid of the episode |\n| Episode ID | number | 123 | Podscribe ID of the episode, if applicable. |\n| Campaign Promo | string | SALE20 | A string value representing a promotional code associated with a campaign |\n| Campaign Geo | string | United States | Name of the campaign country |\n| Incrementality Source | string | Synthetic - Channel | Provenance of the row's incrementality values. Possible values: \"SmartServe\", \"SmartServe (PSA)\", \"SmartServe (Holdout)\", \"Synthetic - Campaign\", or \"Synthetic - Channel\". Excluded by default; explicitly add this field and enable `showIncrementalResults`. Not available with `geoGrouping`. |\n| Incremental Visitors | number | 123 | Incremental visitors vs holdout. Requires `showIncrementalResults`. |\n| Incremental Visitors % | number | 0.05 | Incremental visitors as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Visitors Modeled | number | 123 | Modeled incremental visitors. Requires `showIncrementalResults`. |\n| Incremental Visitors Modeled % | number | 0.05 | Modeled incremental visitors as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors Campaign Incremental % | number | 0.05 | Campaign-level visitors incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Visitors Channel Incremental % | number | 0.05 | Channel-level visitors incrementality. Requires `showIncrementalResults`. |\n| Incremental Leads | number | 123 | Incremental leads vs holdout. Requires `showIncrementalResults`. |\n| Incremental Leads % | number | 0.05 | Incremental leads as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Leads Modeled | number | 123 | Modeled incremental leads. Requires `showIncrementalResults`. |\n| Incremental Leads Modeled % | number | 0.05 | Modeled incremental leads as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads Campaign Incremental % | number | 0.05 | Campaign-level leads incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Leads Channel Incremental % | number | 0.05 | Channel-level leads incrementality. Requires `showIncrementalResults`. |\n| Incremental Installs | number | 123 | Incremental installs vs holdout. Requires `showIncrementalResults`. |\n| Incremental Installs % | number | 0.05 | Incremental installs as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Installs Modeled | number | 123 | Modeled incremental installs. Requires `showIncrementalResults`. |\n| Incremental Installs Modeled % | number | 0.05 | Modeled incremental installs as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs Campaign Incremental % | number | 0.05 | Campaign-level installs incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Installs Channel Incremental % | number | 0.05 | Channel-level installs incrementality. Requires `showIncrementalResults`. |\n| Incremental Signups | number | 123 | Incremental signups vs holdout. Requires `showIncrementalResults`. |\n| Incremental Signups % | number | 0.05 | Incremental signups as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Signups Modeled | number | 123 | Modeled incremental signups. Requires `showIncrementalResults`. |\n| Incremental Signups Modeled % | number | 0.05 | Modeled incremental signups as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups Campaign Incremental % | number | 0.05 | Campaign-level signups incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Signups Channel Incremental % | number | 0.05 | Channel-level signups incrementality. Requires `showIncrementalResults`. |\n| Incremental Purchases | number | 123 | Incremental purchases vs holdout. Requires `showIncrementalResults`. |\n| Incremental Purchases % | number | 0.05 | Incremental purchases as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Purchases Modeled | number | 123 | Modeled incremental purchases. Requires `showIncrementalResults`. |\n| Incremental Purchases Modeled % | number | 0.05 | Modeled incremental purchases as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases Campaign Incremental % | number | 0.05 | Campaign-level purchases incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Purchases Channel Incremental % | number | 0.05 | Channel-level purchases incrementality. Requires `showIncrementalResults`. |\n| Incremental Visits | number | 123 | Incremental visits vs holdout. Requires `showIncrementalResults`. |\n| Incremental Visits % | number | 0.05 | Incremental visits as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Visits Modeled | number | 123 | Modeled incremental visits. Requires `showIncrementalResults`. |\n| Incremental Visits Modeled % | number | 0.05 | Modeled incremental visits as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits Campaign Incremental % | number | 0.05 | Campaign-level visits incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Visits Channel Incremental % | number | 0.05 | Channel-level visits incrementality. Requires `showIncrementalResults`. |\n| Incremental Revenue | number | 123 | Incremental revenue vs holdout. Requires `showIncrementalResults`. |\n| Incremental Revenue Modeled | number | 123 | Modeled incremental revenue. Requires `showIncrementalResults`. |\n| Visits Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level visits incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Visits Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level visits incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Visitors Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level visitors incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Visitors Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level visitors incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Signups Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level signups incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Signups Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level signups incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Purchases Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level purchases incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Purchases Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level purchases incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Installs Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level installs incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Installs Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level installs incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Leads Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level leads incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Leads Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level leads incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Downloads Incremental | number | 123 | Incremental downloads. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Incremental Modeled | number | 123 | Modeled incremental downloads. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Campaign Incremental % | number | 0.05 | Campaign-level downloads incrementality. Smart promo reports only. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Downloads Channel Incremental % | number | 0.05 | Channel-level downloads incrementality. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level downloads incrementality confidence interval. Smart promo reports only. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Downloads Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level downloads incrementality confidence interval. Smart promo reports only. Requires `showIncrementalResults`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Conversions Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level conversions incrementality confidence interval. Smart promo reports only. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Conversions Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level conversions incrementality confidence interval. Smart promo reports only. Requires `showIncrementalResults`. Excluded by default; request via `fields`. Not available with `geoGrouping`. |\n| Campaign Start Date | string | 2015-03-19 | Campaign start date in the format YYYY-mm-DD |\n| Campaign End Date | string | 2015-03-19 | Campaign end date in the format YYYY-mm-DD |\n| Campaign Expected Date| string | 2015-03-19 | Campaign expected date in the format YYYY-mm-DD |\n| Campaign Spend | number | 5000 | Booked cost of the campaign flight, or Podscribe's estimate when no rate is set. Blank for flights priced by CPM. Unlike Spend, this is planned rather than delivered. Excluded by default; request via `fields`. |\n| Expected Impressions | number | 250000 | Number of impressions the campaign flight was booked to deliver, as opposed to the delivered impression columns. Excluded by default; request via `fields`. |\n| Adswizz Campaign ID | string | 12345 | Adswizz campaign ID from pixel params (Adswizz platforms: adswizz, streaming_adswizz, adswizz_ron, streaming_adswizz_simple). Only populated when the column is requested and impressions were served via Adswizz. |\n| Month | string | 2023-12-01 | First day of the month in YYYY-mm-DD. Present when `timeGrouping` is `month`. |\n| eCPM | number | 12.5 | Estimated cost per thousand impressions. Excluded by default; request via `fields`. |\n| CPM | number | 10 | Cost per thousand impressions. Excluded by default; request via `fields`. |\n| CPA | number | 15 | Cost per acquisition. Available only for advertisers with CPA billing enabled. |\n| Genre | string | Comedy | Genre of the show. Excluded by default; request via `fields`. |\n| Episode Duration | number | 3600 | Episode duration in seconds. Excluded by default; request via `fields`. |\n| Ad Servers | string | megaphone | Ad servers that served the impressions. Excluded by default; request via `fields`. |\n| Frequency | number | 1.5 | Average impressions per unique listener. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors % | number | 0.05 | Visitors as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits % | number | 0.04 | Visits as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads % | number | 0.01 | Leads as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs % | number | 0.01 | Installs as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups % | number | 0.02 | Signups as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases % | number | 0.02 | Purchases as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors Modeled % | number | 0.05 | Modeled visitors as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits Modeled % | number | 0.04 | Modeled visits as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads Modeled % | number | 0.01 | Modeled leads as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs Modeled % | number | 0.01 | Modeled installs as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups Modeled % | number | 0.02 | Modeled signups as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases Modeled % | number | 0.02 | Modeled purchases as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Downloads | number | 123 | Download count. Smart promo reports only. |\n| New Downloads | number | 123 | New download count. Smart promo reports only. |\n| New Subscriber Downloads | number | 123 | New subscriber download count. Smart promo reports only. |\n| New Subscribers | number | 123 | New subscriber count. Smart promo reports only. |\n| Converted Devices | number | 123 | Converted device count. Smart promo reports only. |\n| New Conversions | number | 123 | New conversion count. Smart promo reports only. |\n| Downloads Modeled | number | 123 | Modeled download count. Smart promo reports only. |\n| New Downloads Modeled | number | 123 | Modeled new download count. Smart promo reports only. |\n| New Subscriber Downloads Modeled | number | 123 | Modeled new subscriber download count. Smart promo reports only. |\n| New Subscribers Modeled | number | 123 | Modeled new subscriber count. Smart promo reports only. |\n| Converted Devices Modeled | number | 123 | Modeled converted device count. Smart promo reports only. |\n| New Conversions Modeled | number | 123 | Modeled new conversion count. Smart promo reports only. |\n| ROAS | number | 2.5 | Return on advertising spend. Available when `timeGrouping` is `all`. |\n| ROAS Modeled | number | 2.5 | Modeled return on advertising spend. Available when `timeGrouping` is `all`. |\n| AOV | number | 45 | Average order value. Available when `timeGrouping` is `all`. |\n| AOV Modeled | number | 45 | Modeled average order value. Available when `timeGrouping` is `all`. |\n| Cost Per Visitor | number | 12 | Spend divided by visitors. Available when `timeGrouping` is `all`. |\n| Cost Per Visitor Modeled | number | 12 | Spend divided by modeled visitors. Available when `timeGrouping` is `all`. |\n| Cost Per Lead | number | 20 | Spend divided by leads. Available when `timeGrouping` is `all`. |\n| Cost Per Lead Modeled | number | 20 | Spend divided by modeled leads. Available when `timeGrouping` is `all`. |\n| Cost Per Install | number | 25 | Spend divided by installs. Available when `timeGrouping` is `all`. |\n| Cost Per Install Modeled | number | 25 | Spend divided by modeled installs. Available when `timeGrouping` is `all`. |\n| Cost Per Signup | number | 18 | Spend divided by signups. Available when `timeGrouping` is `all`. |\n| Cost Per Signup Modeled | number | 18 | Spend divided by modeled signups. Available when `timeGrouping` is `all`. |\n| Cost Per Purchase | number | 30 | Spend divided by purchases. Available when `timeGrouping` is `all`. |\n| Cost Per Purchase Modeled | number | 30 | Spend divided by modeled purchases. Available when `timeGrouping` is `all`. |\n| Cost Per Incremental Visitor | number | 12 | Spend divided by incremental visitors. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Visitor Modeled | number | 12 | Spend divided by modeled incremental visitors. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Lead | number | 20 | Spend divided by incremental leads. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Lead Modeled | number | 20 | Spend divided by modeled incremental leads. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Install | number | 25 | Spend divided by incremental installs. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Install Modeled | number | 25 | Spend divided by modeled incremental installs. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Signup | number | 18 | Spend divided by incremental signups. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Signup Modeled | number | 18 | Spend divided by modeled incremental signups. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Purchase | number | 30 | Spend divided by incremental purchases. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Purchase Modeled | number | 30 | Spend divided by modeled incremental purchases. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental ROAS | number | 2.5 | Incremental return on advertising spend. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental ROAS Modeled | number | 2.5 | Modeled incremental return on advertising spend. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Itunes ID | string | 123 | iTunes ID of the show. Hidden by default; request via `fields`. |\n| YouTube Channel / Playlist ID | string | UCxxxx | YouTube channel or playlist ID of the show. Hidden by default; request via `fields`. |\n| Campaign & Initiative | string | Campaign / Initiative | Combined campaign and initiative label. |\n| Campaign Unit | string | Mid | Booked campaign unit. Excluded by default; request via `fields`. |\n| Campaign Creatives | string | Creative A | Campaign creative names. Excluded by default; request via `fields`. |\n| Advertiser Industry | string | Retail | Advertiser industry. Excluded by default; request via `fields`. |\n| Offline Purchases | number | 12 | Offline purchase conversions. Excluded by default; request via `fields`. |\n| Online Purchases | number | 80 | Online purchase conversions. Excluded by default; request via `fields`. |\n| Offline Purchases Modeled | number | 12 | Modeled offline purchase conversions. Excluded by default; request via `fields`. |\n| Online Purchases Modeled | number | 80 | Modeled online purchase conversions. Excluded by default; request via `fields`. |\n| Offline Revenue | number | 400 | Offline revenue. Excluded by default; request via `fields`. |\n| Online Revenue | number | 3200 | Online revenue. Excluded by default; request via `fields`. |\n| Offline Revenue Modeled | number | 400 | Modeled offline revenue. Excluded by default; request via `fields`. |\n| Online Revenue Modeled | number | 3200 | Modeled online revenue. Excluded by default; request via `fields`. |\n| Bill To | string | Agency | Billing account. Excluded by default; request via `fields`. |\n| Campaign Delivery Issues | string | WRONG GEO | Campaign delivery issue flags. Excluded by default; request via `fields`. Not available for limited-overview API keys. |\n| Campaign Placement Issues | string | STALE READ | Campaign placement issue flags. Excluded by default; request via `fields`. Not available for limited-overview API keys. |\n| YouTube Engaged Views | number | 123 | Engaged YouTube views when Engaged Views is enabled. Hidden by default; request via `fields`. |\n| Geo | string | US | Geographic grouping value. Available when `geoGrouping` is provided. |\n| Country | string | US | Country. Available when `geoGrouping` is provided. Excluded by default; request via `fields`. |\n| DMA Code | string | 501 | DMA code. Available when `geoGrouping` is `\"DMA\"`. Excluded by default; request via `fields`. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Week\",\n \"Day\",\n \"Advertiser\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Promo codes\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"ytSimulcastConvWeight\": 1,\n \"rSimulcastConvWeight\": 0.7,\n \"svSimulcastConvWeight\": 0.7,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"incCiCertainty\": 95,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"geoGrouping\": \"zip\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"aggregateEpisodicBuysPerShow\": false,\n \"skipCampaignTransliteration\": false,\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false,\n \"modelPublicSpaceIps\": true,\n \"modelOffline\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c1659465-86fb-44ac-80f0-4d309d8a6920", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Week\",\n \"Day\",\n \"Advertiser\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Promo codes\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"ytSimulcastConvWeight\": 1,\n \"rSimulcastConvWeight\": 0.7,\n \"svSimulcastConvWeight\": 0.7,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"incCiCertainty\": 95,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"geoGrouping\": \"DMA\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"aggregateEpisodicBuysPerShow\": false,\n \"skipCampaignTransliteration\": false,\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false,\n \"modelPublicSpaceIps\": true,\n \"modelOffline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4fbd8e4-d1f5-4791-ac00-b7197e1d7522", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Week\",\n \"Day\",\n \"Advertiser\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Promo codes\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"ytSimulcastConvWeight\": 1,\n \"rSimulcastConvWeight\": 0.7,\n \"svSimulcastConvWeight\": 0.7,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"incCiCertainty\": 95,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"geoGrouping\": \"DMA\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"aggregateEpisodicBuysPerShow\": false,\n \"skipCampaignTransliteration\": false,\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false,\n \"modelPublicSpaceIps\": true,\n \"modelOffline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "06a98d42-3be3-4fcc-a336-a29bf88c45c2", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "impressions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Week\",\n \"Day\",\n \"Advertiser\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Promo codes\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"ytSimulcastConvWeight\": 1,\n \"rSimulcastConvWeight\": 0.7,\n \"svSimulcastConvWeight\": 0.7,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"incCiCertainty\": 95,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"geoGrouping\": \"DMA\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"aggregateEpisodicBuysPerShow\": false,\n \"skipCampaignTransliteration\": false,\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false,\n \"modelPublicSpaceIps\": true,\n \"modelOffline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "304519d2-adb0-48b5-a15a-53c7af6f0727", "name": "Attributed Conversions", "request": { "name": "Attributed Conversions", "description": { "content": "**Note:** An organization-scoped API key is limited to its own advertiser and publisher. Attribution weights stay as calculated across all touches. Purchase amount, weighted purchase amount, order id, IP, device ids, user agents, postal codes, hashed email, Meta, landing and referrer URLs, and the survey response are omitted and cannot be requested back through `fields`. Promo rows are omitted. A purchase that has a survey answer stays.\n\nAttributed conversions with their action, order value, credit weight, campaign, show, episode and device details.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|---------------------------------|----------|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|\n| Advertiser | string | demoAdvertiser | Name of the advertiser the conversion belongs to. |\n| Purchased At | string | 2023-12-23 9:58 AM | Date and time of purchase. Default is YYYY-MM-DD h:mm AM/PM. `timeFormat` selects another pattern. `excludeTime` writes the date only. |\n| Action | string | install | Type of action performed. Nullable only for promo. |\n| Discount code | string | someCode | Discount code used. |\n| Purchase Amount | number | 123 | Amount of purchase. |\n| Weighted Purchase Amount | number | 123 | Weighted value of the purchase: Conversion Weight * Purchase Amount. |\n| Conversion Weight | number | 0.05 | Conversion weight (0-1) based on attribution mode (first, last, multi-linear, multi-time decay) for credit distribution within exposures. |\n| Order number | string | aaa-bbb-ccc | Unique identifier for the order. |\n| Media Type | string | podcast | Type of media where the ad was run; values include \"podcast\", \"podcast and youtube\", \"youtube\", \"simulcast\", \"streaming\" |\n| Campaign | string | My campaign | Name of the advertising campaign. |\n| Tags | string | Retail | Tags associated with the ad. |\n| Category | string | baked-in | Type of ad category; values include \"baked-in\", \"dai\", \"promo code\" |\n| Publisher | string | Some publisher | Name of the ad publisher. With `fieldsVersion: 2` the header is `Publisher (from Campaign)`. |\n| Show Last Listened To | string | Some show | Name of the last show listened to by the user. |\n| Show Last Listened To ID | string | show-id | Podscribe ID of the last show listened to by the user. |\n| Publisher Show / Station Name | string | Some station | Name of the show or station for streaming ads. Only for streaming. With `fieldsVersion: 2` the header is `Publisher's Show / Station Name`. |\n| Episode | string | Some Ep | Episode where the ad was run. |\n| Episode ID | string | episode-id | Podscribe ID of the episode where the ad was run. |\n| Last Heard Ad | string | 2023-12-18 9:23 AM | Time and date of the last heard ad, in the format YYYY-mm-DD HH:MM tt |\n| Landing URL | string | https://example.com | URL of the landing page after the ad. |\n| Referer URL | string | https://example.com/buy | Referrer URL of the purchase page. |\n| New customer | bool | false | Boolean indicating if the customer is new. |\n| Conversion UA | string | Mozilla/5.0 (\\) \\ (\\) \\ | User agent string of the conversion. |\n| Impression UA | string | Mozilla/5.0 (\\) \\ (\\) \\ | User agent string at the time of ad impression. |\n| IP | string | 123.123.123.123 | IP address of the user on their conversion. |\n| Currency | string | USD | Currency code, always USD. |\n| ISP Weight | number | 2 | The inversion of the fraction of the campaign's impressions were residential. |\n| Mobile Ad ID | string | aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee | Converting device's Google Advertising ID (Android) or Identifier for Advertisers. (IOS) |\n| Device ID | string | aaa-bbb-ccc | Unique identifier for the user's device; typically the Podscribe cookie ID. |\n| Raw Action | string | event1 | Raw action data (if input action is different than Podscribe action name). Nullable only for promo |\n| Country | string | us | Country obtained from the conversion IP address. |\n| DMA | string | COLUMBIA-JEFFERSON CITY | DMA obtained from the conversion IP address. |\n| Zip | string | 12345 | Zip obtained from the conversion IP address. |\n| Hashed Email | string | | Hash code sha256 or md5. |\n| Meta | string | {\"some\": \"generic data\"} | Custom parameters from tag. |\n| Campaign Internal ID | string | mycampaign | The campaign's identifier in Podscribe. |\n| Podscribe Campaign ID | string | 3105cc60-3970-11f1-a827-67ac2fdfebc6 | Unique Podscribe campaign request ID. |\n| Publisher ID | string | 123 | Podscribe publisher ID. |\n| Product (from Campaign) | string | some-product-from-campaign | The product name from campaign. |\n| Initiative | string | some-initiative | The initiative name. |\n| Survey Response | string | Idk. Steve-o | The Survey Response which was matched with the Podcast name by ChatGPT |\n| Creative id | string | creative-id | Creative ID |\n| Product (from Event) | string | some-product-from-event | The product name from event. |\n| Business Line | string | some-business-line | The business line name. |\n| Show iTunes ID | string | 123 | The iTunes ID of the show. |\n| Campaign & Initiative | string | Campaign / Initiative | Combined campaign and initiative label. |\n| Prog. Publisher | string | Some publisher | Name of the Prog. Publisher from pixel. With `fieldsVersion: 2` the header is `Programmatic Publisher (from Macro)`. |\n| Session Landing URL | string | https://example.com/session | Landing URL recorded for the converting session. |\n| Session Referer URL | string | https://example.com/ref | Referrer URL recorded for the converting session. |\n| Event URL | string | https://example.com/event | URL associated with the conversion event. |\n| Genre | string | Comedy | Genre of the last show listened to. Excluded by default; request via `fields`. |\n| Impression Zip | string | 10001 | ZIP code of the attributed impression. Excluded by default; request via `fields`. |\n| Impression Region (State) | string | NY | Region/state of the attributed impression. Excluded by default; request via `fields`. |\n| Impression City | string | New York | City of the attributed impression. Excluded by default; request via `fields`. |\n| Ad Server | string | megaphone | Ad server that served the impression. Excluded by default; request via `fields`. |\n| Impression Normalized User Agent | string | Chrome | Normalized user agent of the attributed impression. Excluded by default; request via `fields`. |\n| Conversion Device | string | iPhone | Device class of the conversion. Excluded by default; request via `fields`. |\n| Device | string | iPhone | Device class of the attributed impression. Excluded by default; request via `fields`. |\n| Ad Position (from Ad Server) | string | preroll | Ad position from the ad server. Excluded by default; request via `fields`. |\n| Ad Zone ID | string | zone-1 | Ad zone ID from the ad server. Excluded by default; request via `fields`. |\n| Privacy | string | LAT | Privacy signal from the impression. Excluded by default; request via `fields`. |\n| Device (Ad Server) | string | iOS | Device reported by the ad server. Excluded by default; request via `fields`. |\n| Prog. Supply Vendor | string | some-vendor | Programmatic supply vendor from the impression. Excluded by default; request via `fields`. |\n| Campaign Promo | string | SALE20 | Promotional code associated with the campaign. Excluded by default; request via `fields`. |\n| IPv6 Weight | number | 1 | Weight applied for IPv6 impressions. Excluded by default; request via `fields`. |\n| Campaign ID | string | some-campaign-id | Internal campaign identifier. Excluded by default; request via `fields`. |\n| Site | string | example.com | Site associated with the impression. Excluded by default; request via `fields`. |\n| Impression UUID | string | 3105cc60-3970-11f1-a827-67ac2fdfebc6 | UUID of the attributed impression. Excluded by default; request via `fields`. |\n| IPv4 | string | 123.123.123.123 | IPv4 address when available. Excluded by default; request via `fields`. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"fields\": [\n \"Advertiser\",\n \"Purchased At\",\n \"Action\",\n \"Discount code\",\n \"Purchase Amount\",\n \"Weighted Purchase Amount\",\n \"Conversion Weight\",\n \"Order number\",\n \"Media Type\",\n \"Campaign\",\n \"Tags\",\n \"Category\",\n \"Publisher\",\n \"Show Last Listened To\",\n \"Show Last Listened To ID\",\n \"Publisher Show / Station Name\",\n \"Episode\",\n \"Episode ID\",\n \"Last Heard Ad\",\n \"Landing URL\",\n \"Referer URL\",\n \"New customer\",\n \"Conversion UA\",\n \"Impression UA\",\n \"IP\",\n \"Currency\",\n \"ISP Weight\",\n \"Mobile Ad ID\",\n \"Device ID\",\n \"Raw Action\",\n \"Country\",\n \"Hashed Email\",\n \"Meta\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product (from Campaign)\",\n \"Initiative\",\n \"Survey Response\",\n \"Creative id\",\n \"Product (from Event)\",\n \"Business Line\",\n \"Show iTunes ID\",\n \"Campaign & Initiative\",\n \"Prog. Publisher\",\n \"Session Landing URL\",\n \"Session Referer URL\",\n \"Event URL\"\n ],\n \"fieldsVersion\": 1,\n \"fieldsMapping\": {\n \"Purchased At\": \"converted_at\",\n \"Discount code\": \"promo_code\"\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"withVisitors\": false,\n \"attributionModel\": \"multi_timedecay\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionPreset\": \"any\",\n \"excludePromos\": false,\n \"excludeSurveys\": false,\n \"excludeTime\": false,\n \"timeFormat\": \"12h\",\n \"events\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b0dcd3a0-4156-42f7-b9e7-6248776e6833", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"fields\": [\n \"Advertiser\",\n \"Purchased At\",\n \"Action\",\n \"Discount code\",\n \"Purchase Amount\",\n \"Weighted Purchase Amount\",\n \"Conversion Weight\",\n \"Order number\",\n \"Media Type\",\n \"Campaign\",\n \"Tags\",\n \"Category\",\n \"Publisher\",\n \"Show Last Listened To\",\n \"Show Last Listened To ID\",\n \"Publisher Show / Station Name\",\n \"Episode\",\n \"Episode ID\",\n \"Last Heard Ad\",\n \"Landing URL\",\n \"Referer URL\",\n \"New customer\",\n \"Conversion UA\",\n \"Impression UA\",\n \"IP\",\n \"Currency\",\n \"ISP Weight\",\n \"Mobile Ad ID\",\n \"Device ID\",\n \"Raw Action\",\n \"Country\",\n \"Hashed Email\",\n \"Meta\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product (from Campaign)\",\n \"Initiative\",\n \"Survey Response\",\n \"Creative id\",\n \"Product (from Event)\",\n \"Business Line\",\n \"Show iTunes ID\",\n \"Campaign & Initiative\",\n \"Prog. Publisher\",\n \"Session Landing URL\",\n \"Session Referer URL\",\n \"Event URL\"\n ],\n \"fieldsVersion\": 1,\n \"fieldsMapping\": {\n \"Purchased At\": \"converted_at\",\n \"Discount code\": \"promo_code\"\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"withVisitors\": false,\n \"attributionModel\": \"multi_timedecay\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionPreset\": \"any\",\n \"excludePromos\": false,\n \"excludeSurveys\": false,\n \"excludeTime\": false,\n \"timeFormat\": \"12h\",\n \"events\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "825e04b4-6ca7-48e9-a8f0-c3024ced16dc", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"fields\": [\n \"Advertiser\",\n \"Purchased At\",\n \"Action\",\n \"Discount code\",\n \"Purchase Amount\",\n \"Weighted Purchase Amount\",\n \"Conversion Weight\",\n \"Order number\",\n \"Media Type\",\n \"Campaign\",\n \"Tags\",\n \"Category\",\n \"Publisher\",\n \"Show Last Listened To\",\n \"Show Last Listened To ID\",\n \"Publisher Show / Station Name\",\n \"Episode\",\n \"Episode ID\",\n \"Last Heard Ad\",\n \"Landing URL\",\n \"Referer URL\",\n \"New customer\",\n \"Conversion UA\",\n \"Impression UA\",\n \"IP\",\n \"Currency\",\n \"ISP Weight\",\n \"Mobile Ad ID\",\n \"Device ID\",\n \"Raw Action\",\n \"Country\",\n \"Hashed Email\",\n \"Meta\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product (from Campaign)\",\n \"Initiative\",\n \"Survey Response\",\n \"Creative id\",\n \"Product (from Event)\",\n \"Business Line\",\n \"Show iTunes ID\",\n \"Campaign & Initiative\",\n \"Prog. Publisher\",\n \"Session Landing URL\",\n \"Session Referer URL\",\n \"Event URL\"\n ],\n \"fieldsVersion\": 1,\n \"fieldsMapping\": {\n \"Purchased At\": \"converted_at\",\n \"Discount code\": \"promo_code\"\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"withVisitors\": false,\n \"attributionModel\": \"multi_timedecay\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionPreset\": \"any\",\n \"excludePromos\": false,\n \"excludeSurveys\": false,\n \"excludeTime\": false,\n \"timeFormat\": \"12h\",\n \"events\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3dd4e671-0720-4dbd-8231-0748b8206fe8", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"fields\": [\n \"Advertiser\",\n \"Purchased At\",\n \"Action\",\n \"Discount code\",\n \"Purchase Amount\",\n \"Weighted Purchase Amount\",\n \"Conversion Weight\",\n \"Order number\",\n \"Media Type\",\n \"Campaign\",\n \"Tags\",\n \"Category\",\n \"Publisher\",\n \"Show Last Listened To\",\n \"Show Last Listened To ID\",\n \"Publisher Show / Station Name\",\n \"Episode\",\n \"Episode ID\",\n \"Last Heard Ad\",\n \"Landing URL\",\n \"Referer URL\",\n \"New customer\",\n \"Conversion UA\",\n \"Impression UA\",\n \"IP\",\n \"Currency\",\n \"ISP Weight\",\n \"Mobile Ad ID\",\n \"Device ID\",\n \"Raw Action\",\n \"Country\",\n \"Hashed Email\",\n \"Meta\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product (from Campaign)\",\n \"Initiative\",\n \"Survey Response\",\n \"Creative id\",\n \"Product (from Event)\",\n \"Business Line\",\n \"Show iTunes ID\",\n \"Campaign & Initiative\",\n \"Prog. Publisher\",\n \"Session Landing URL\",\n \"Session Referer URL\",\n \"Event URL\"\n ],\n \"fieldsVersion\": 1,\n \"fieldsMapping\": {\n \"Purchased At\": \"converted_at\",\n \"Discount code\": \"promo_code\"\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"withVisitors\": false,\n \"attributionModel\": \"multi_timedecay\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionPreset\": \"any\",\n \"excludePromos\": false,\n \"excludeSurveys\": false,\n \"excludeTime\": false,\n \"timeFormat\": \"12h\",\n \"events\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2527ea0-2c85-4043-adc6-105b7bdb0554", "name": "Request timed out while validating the request. No report task was created.", "originalRequest": { "url": { "path": [ "api", "public", "conversions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"fields\": [\n \"Advertiser\",\n \"Purchased At\",\n \"Action\",\n \"Discount code\",\n \"Purchase Amount\",\n \"Weighted Purchase Amount\",\n \"Conversion Weight\",\n \"Order number\",\n \"Media Type\",\n \"Campaign\",\n \"Tags\",\n \"Category\",\n \"Publisher\",\n \"Show Last Listened To\",\n \"Show Last Listened To ID\",\n \"Publisher Show / Station Name\",\n \"Episode\",\n \"Episode ID\",\n \"Last Heard Ad\",\n \"Landing URL\",\n \"Referer URL\",\n \"New customer\",\n \"Conversion UA\",\n \"Impression UA\",\n \"IP\",\n \"Currency\",\n \"ISP Weight\",\n \"Mobile Ad ID\",\n \"Device ID\",\n \"Raw Action\",\n \"Country\",\n \"Hashed Email\",\n \"Meta\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product (from Campaign)\",\n \"Initiative\",\n \"Survey Response\",\n \"Creative id\",\n \"Product (from Event)\",\n \"Business Line\",\n \"Show iTunes ID\",\n \"Campaign & Initiative\",\n \"Prog. Publisher\",\n \"Session Landing URL\",\n \"Session Referer URL\",\n \"Event URL\"\n ],\n \"fieldsVersion\": 1,\n \"fieldsMapping\": {\n \"Purchased At\": \"converted_at\",\n \"Discount code\": \"promo_code\"\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"withVisitors\": false,\n \"attributionModel\": \"multi_timedecay\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionPreset\": \"any\",\n \"excludePromos\": false,\n \"excludeSurveys\": false,\n \"excludeTime\": false,\n \"timeFormat\": \"12h\",\n \"events\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9cd8ccb4-55f4-4440-87e8-4d8eb4adeb2f", "name": "Incrementality", "request": { "name": "Incrementality", "description": { "content": "Test and control group counts, lift and incrementality per advertiser, action and period, by channel, publisher or campaign.", "type": "text/plain" }, "url": { "path": [ "api", "public", "incrementality" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"aggregationLevel\": \"channel\",\n \"channelType\": \"podcast\",\n \"action\": \"string\",\n \"startDate\": \"2013-04-01\",\n \"endDate\": \"1987-09-27\",\n \"includeErrors\": false,\n \"incCiCertainty\": 95\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dc62eb0b-f65f-4bb3-830d-a8513ccebc6d", "name": "An array of incrementality results.", "originalRequest": { "url": { "path": [ "api", "public", "incrementality" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"aggregationLevel\": \"channel\",\n \"channelType\": \"podcast\",\n \"action\": \"string\",\n \"startDate\": \"2013-04-01\",\n \"endDate\": \"1987-09-27\",\n \"includeErrors\": false,\n \"incCiCertainty\": 95\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"advertiser\": \"string\",\n \"aggregationLevel\": \"publisher\",\n \"channelType\": \"string\",\n \"action\": \"string\",\n \"startDate\": \"1955-06-13\",\n \"endDate\": \"1959-10-03\",\n \"campaignName\": \"string\",\n \"publisher\": \"string\",\n \"controlGroupActionCount\": 3442,\n \"testGroupActionCount\": 7147,\n \"controlGroupSize\": 7286,\n \"testGroupSize\": 7479,\n \"lift\": 8349.420322221013,\n \"incremental\": 9779.01847920577,\n \"liftConfidenceIntervalLowerBound\": 1003.4241781089027,\n \"liftConfidenceIntervalUpperBound\": 272.3700869435763,\n \"incrementalConfidenceIntervalLowerBound\": 2707.387928100864,\n \"incrementalConfidenceIntervalUpperBound\": 6583.501196921157,\n \"error\": \"string\"\n },\n {\n \"advertiser\": \"string\",\n \"aggregationLevel\": \"channel\",\n \"channelType\": \"string\",\n \"action\": \"string\",\n \"startDate\": \"1970-04-15\",\n \"endDate\": \"1990-01-21\",\n \"campaignName\": \"string\",\n \"publisher\": \"string\",\n \"controlGroupActionCount\": 115,\n \"testGroupActionCount\": 2664,\n \"controlGroupSize\": 6509,\n \"testGroupSize\": 3234,\n \"lift\": 6951.838200609657,\n \"incremental\": 2183.1247618700613,\n \"liftConfidenceIntervalLowerBound\": 7489.465026219579,\n \"liftConfidenceIntervalUpperBound\": 7762.326346067932,\n \"incrementalConfidenceIntervalLowerBound\": 287.8188807709381,\n \"incrementalConfidenceIntervalUpperBound\": 3187.791712718353,\n \"error\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8eec446c-7f72-48f4-a72b-33dbe19531d5", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "incrementality" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"aggregationLevel\": \"channel\",\n \"channelType\": \"podcast\",\n \"action\": \"string\",\n \"startDate\": \"2013-04-01\",\n \"endDate\": \"1987-09-27\",\n \"includeErrors\": false,\n \"incCiCertainty\": 95\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "485d2e7c-5321-41ef-a032-ada05af9a36c", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "incrementality" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"aggregationLevel\": \"channel\",\n \"channelType\": \"podcast\",\n \"action\": \"string\",\n \"startDate\": \"2013-04-01\",\n \"endDate\": \"1987-09-27\",\n \"includeErrors\": false,\n \"incCiCertainty\": 95\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ecfa743b-f889-47fc-bd93-cc7899dd66d9", "name": "Campaigns Performance", "request": { "name": "Campaigns Performance", "description": { "content": "**Note:** An organization-scoped API key includes only flights for that key's advertiser and publisher. Attribution the publisher cannot see stays hidden.\n\nDelivery status, impressions, conversions and costs for each campaign in the campaign tracking sheet.\n\n\n> For the most accurate YouTube Engaged Views and attribution numbers, set `endDate` to at least 3 days before today. Numbers in the last 3 days may include estimates and can change once YouTube reports actual data.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|--------------------------------------------------|--------|----------------------------------|------------------------------------------------------------------------------------|\n| Advertiser | string | Coca-Cola | Name of the advertising company |\n| Publisher | string | Spotify | Name of the publishing platform |\n| Campaign | string | Summer Promo | Name of the advertising campaign |\n| Podcast | string | Tech Talk | Name of the podcast |\n| Tags | string | Tech, Sports | Tags associated with the campaign |\n| Geo | string | US, UK | Geographical location targeted by the campaign |\n| Start date | string | 4/8/2024 | Start date of the campaign |\n| End date | string | 4/15/2024 | End date of the campaign |\n| Expected | string | 4/8/2024 | Expected air date of the campaign |\n| Category | string | Baked-in | Category of the campaign |\n| Unit | string | Mid | Type of advertising unit |\n| Expected Impressions | number | 250000 | Expected number of impressions |\n| Spend | number | 5882 | Amount spent on the campaign |\n| CPM | string | 631 $ | Cost per mille (thousand) impressions |\n| Ads | number | 12 | Number of ads found |\n| Status | string | WRONG GEO, STALE READ | Column indicating the status and error flags. |\n| Impressions Source | string | Prefix | Source used for impression counts |\n| Impressions | number | 126301 | Number of impressions |\n| Podcast Downloads | number | 115752 | Number of podcast impressions |\n| YouTube Views | number | 10549 | Number of YouTube views |\n| Rumble Views | number | 9000 | Rumble view impressions |\n| 7d Impressions | number | 10000 | Impressions counted within 7 days |\n| 15d Impressions | number | 20000 | Impressions counted within 15 days |\n| 30d Impressions | number | 30000 | Impressions counted within 30 days |\n| 45d Impressions | number | 40000 | Impressions counted within 45 days |\n| 60d Impressions | number | 50000 | Impressions counted within 60 days |\n| Reach | number | 112322 | Reach of the campaign |\n| Freq. | number | 1.0 | Frequency of the campaign |\n| Clicks | number | 321 | Number of clicks |\n| Clicks % | number | 0.003 | Click rate |\n| Cost Per Click | number | 18.32 | Spend divided by clicks |\n| Visitors | number | 112.94 | Number of visitors reached |\n| Visitor % | number | 0.083 % | Percentage of visitors reached |\n| Cost Per Visitor | number | 52.08 | Spend divided by visitors |\n| Visits | number | 588 | Number of visits |\n| Visit % | number | 0.000 % | Percentage of visits |\n| Cost Per Visit | number | 10.0 | Spend divided by visits |\n| Installs | number | 0.16 | Number of app installs |\n| Install % | number | 0.001 | Install rate |\n| Cost Per Install | number | 367.63 | Spend divided by installs |\n| Signups | number | 3.8 | Number of signups |\n| Signup % | number | 0.003 | Signup rate |\n| Cost Per Signup | number | 154.79 | Spend divided by signups |\n| Leads | number | 4.2 | Number of leads generated |\n| Lead % | number | 0.003 | Lead rate |\n| Cost Per Lead | number | 140.05 | Spend divided by leads |\n| Convs. | number | 2.3 | Number of conversions |\n| Conv. % | number | 0.002 % | Conversion rate |\n| Cost Per Conversion | number | 255.74 | Spend divided by conversions |\n| Revenue | number | 152 | Revenue generated |\n| ROAS | number | 0.02 | Return on advertising spend |\n| CPA | number | 3076 | Cost per acquisition |\n| Computed CPA | number | 1667 | Computed cost per acquisition |\n| Filtered Resolved Status | string | | Flags reflecting the status of campaign issues, with user-defined filtering. |\n| Resolved Status | string | | Flags indicating the status of campaign issues. |\n| Prefix placed | bool | true | Prefix placed |\n| DAI Impression Pixel | string | https://verifi.podscribe.com/... | Link provided to the ad server for data callback configuration. |\n| Comments | string | Some user comments | Additional comments |\n| Ad Server | string | megaphone | Ad server used |\n| SmartPromo Downloads | string | 123 | Number of downloads |\n| Cost Per SmartPromo Download | number | 47.82 | Spend divided by downloads |\n| New Converted Devices | string | 123 | Number of new converted devices |\n| New Converted Device % | number | 0.004 | New converted device rate |\n| Cost Per New Converted Device | number | 47.82 | Spend divided by new converted devices |\n| New Device SmartPromo Downloads | string | 123 | Number of new device downloads |\n| Cost Per New Device SmartPromo Download | number | 47.82 | Spend divided by new device downloads |\n| New Subscriber Downloads | number | 123 | Number of new subscriber downloads |\n| New Subscribers | string | 123 | Number of new subscribers |\n| New Subscribers % | number | 0.004 | New subscriber rate |\n| Cost Per New Subscriber | number | 47.82 | Spend divided by new subscribers |\n| % of impressions to listeners with frequency 15+ | string | 28.8 | Percentage of impressions to listeners with frequency 15+ |\n| % of listeners with frequency 15+ | string | 28.5 | Percentage of listeners with frequency 15+ |\n| Expected Impressions | number | 250000 | Expected number of impressions |\n| Campaign Id | string | some campaign id | Identifier for the campaign |\n| Synced At | string | 4/3/2024, 2:47 AM | Date and time when data was synced |\n| Air Date | string | 2024-04-08 04:08:04.799000+00:00 | The date when the advertising campaign was first aired or broadcasted. |\n| Initiative | string | Spring Campaign | Campaign initiative |\n| Product | string | Premium Plan | Campaign product |\n| Business Line | string | Direct | Campaign business line |\n| DAI Impression Pixel by Creative | string | https://verifi.podscribe.com/... | DAI impression pixel URL for the first creative |\n| Bill To | string | Agency Name | Billing account name |\n| Bill to Publisher | string | Publisher Name | Publisher billing name |\n| Media Type | string | podcast | Media type from the campaign tracking sheet |\n| Extra DAI Impression Pixel by Creative N | string | https://verifi.podscribe.com/... | Additional creative pixel columns can be included when a campaign has more creatives |\n| Promo | string | SUMMER20 | Campaign promo code, if configured. |\n| Vanity URL | string | https://example.com/promo | Vanity URL configured for the campaign, if provided. |\n| Expected landing URL | string | https://example.com/landing | Expected landing URL after redirect, if provided. |\n| UTM Source | string | spotify | UTM source configured for campaign tracking, if provided. |\n| UTM Medium | string | podcast | UTM medium configured for campaign tracking, if provided. |\n| Spotify Video Streams | number | 0 | Spotify Video Streams count |\n| Found Ads | string | [{\"adId\":\"...\",\"audioFileUrl\":\"...\"}] | JSON array of found ads. Includes adId, episodeId, episodeTitle, showTitle, publishedAt, adDuration, startTs, endTs, platform, episodeDuration, episodeUrlInFeed, placementNum, placementPercent, publicLink, transcriptLink, episodeGuid, episodeLength, adTimestamp, adLength, unit, readBy, readScore, transcriptUrl, audioFileUrl (direct HTTPS link to the ad-clip audio file, not the full episode; download it with a plain GET such as curl -O, with no API key, Authorization header or Podscribe login; the API key is needed only to call this endpoint; null when no clip is stored), status (comma-separated placement flags such as BAD PROMO; COMPETITOR may include the competitor name, `/`-separated products, and where it was found, with `;` between competitors and a pipe between where-found groups; DO NOT SAY may include semicolon-separated phrases), and promo (found promo/URL). publicLink is playback; transcriptLink/transcriptUrl open the ad in the transcript. |\n| Radio Impressions | number | 5000 | Number of radio impressions, if applicable. |\n| SmartServe Ad Server | string | smartserve | SmartServe ad server platform, if applicable. |\n| SmartServe Creative | string | Creative A | SmartServe creative name(s), comma-separated. |\n| SmartServe Creative Source URL | string | https://example.com/creative.mp4 | SmartServe creative source URL(s), comma-separated. |\n| SmartServe Targeting Profile | string | Profile A | SmartServe targeting profile name. |\n| SmartServe Banner Name | string | banner.png | SmartServe banner file name(s), comma-separated. |\n| SmartServe Banner Source URL | string | https://example.com/banner.png | SmartServe banner source URL(s), semicolon-separated. |\n| SmartServe Clickthrough URL | string | https://example.com | SmartServe campaign-level clickthrough URL. |\n| SmartServe Campaign Settings (JSON) | string | {\"clname\":\"camp_a\"} | JSON object of SmartServe campaign settings. |\n| SmartServe Targeting Profile Settings (JSON) | string | {\"id\":\"tp_a\"} | JSON object of SmartServe targeting profile settings. |\n| SmartServe VAST URL | string | https://example.com/vast.xml | SmartServe VAST URL. |\n| YouTube Engaged Views | number | 123 | Engaged YouTube views when Engaged Views is enabled. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "campaigns-performance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"startDate\": \"2023-10-10\",\n \"endDate\": \"2023-10-10\",\n \"externalIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "43302ef5-a60c-4aea-8570-296242e2f5a0", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "campaigns-performance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"startDate\": \"2023-10-10\",\n \"endDate\": \"2023-10-10\",\n \"externalIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a81caece-eff0-4910-8399-22cf1265ce8c", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "campaigns-performance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"startDate\": \"2023-10-10\",\n \"endDate\": \"2023-10-10\",\n \"externalIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "92cf08c7-26d5-4f66-85d3-a6b173b9179d", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "campaigns-performance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"startDate\": \"2023-10-10\",\n \"endDate\": \"2023-10-10\",\n \"externalIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b674f57f-e19a-4d35-878e-dd046cd13b0b", "name": "By Campaign & Show", "request": { "name": "By Campaign & Show", "description": { "content": "Impressions, reach, spend and conversions per campaign and show, by day, week or month.\n\n\n> For the most accurate YouTube Engaged Views and attribution numbers, set `endDate` to at least 3 days before today. Numbers in the last 3 days may include estimates and can change once YouTube reports actual data.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\nShow-level reporting access is required. A login whose access is limited to the simple overview or to campaign reporting receives 403 unless it also holds show-level reporting.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|-----------------------|----------|-----------------------|----------------------------------------------------------------------------------------------------------|\n| Month | string | 2023-12-01 | The date of the first day of the month in the format YYYY-mm-DD. Only when `timeGrouping` is `month`; cannot be requested through `fields`. |\n| Week | string | 2023-12-18 | Date of the week in the format YYYY-mm-DD. Only when `timeGrouping` is `day` or `week`. |\n| Day | string | 2023-12-23 | Date of the day in the format YYYY-mm-DD. Only when `timeGrouping` is `day`. |\n| Advertiser | string | demoAdvertiser | Name of the advertiser for the media content. |\n| Media Type | string | podcast | Type of media content, such as \"podcast,\" \"podcast and youtube,\" \"youtube,\" \"simulcast,\" or \"streaming.\" |\n| Type | string | baked-in | Type of ad integration, either \"baked-in\" or \"dai\" (Dynamic Ad Insertion). |\n| Tags | string | Retail | Optional tags associated with the campaign. |\n| Spend | number | 123 | Amount spent on the advertisement, if applicable. |\n| Publisher | string | Some publisher | Name of the publisher or platform hosting the content. |\n| Campaign | string | My Campaign | Name of the advertising campaign. |\n| Show | string | Some Show | Name of the show associated with the media content. |\n| Show ID | number | 123 | Podscribe ID of the show. Excluded by default except for previously enabled advertisers; request via `fields`. |\n| Episode | string | Some Ep | Name or identifier of the specific episode, if applicable. |\n| Publish Date | string | 2023-12-18 | Date when the media content was published, in the format YYYY-mm-DD. |\n| Podcast & Streaming Impressions| number | 123 | Number of podcast & streaming impressions, if applicable. |\n| Delivered Contracted Impressions | number | 123 | DAI impressions within flight dates, capped by expected impressions. Hidden by default; request via `fields`. |\n| YouTube Views | number | 123 | Number of views for YouTube content, if applicable. |\n| Reach | number | 123 | Reach represents the total number of unique users who saw the ad. |\n| Visitors | number | 123 | Number of visitors to a website, if applicable. |\n| Visits | number | 123 | Number of visits to a website, if applicable. |\n| Leads | number | 123 | Number of leads generated, if applicable. |\n| Installs | number | 123 | Number of app installations, if applicable. |\n| Signups | number | 123 | Number of signups or registrations, if applicable. |\n| Purchases | number | 123 | Number of purchases made, if applicable. |\n| Revenue | number | 123 | Revenue generated, if applicable. |\n| Visitors Modeled | number | 123 | Modeled number of visitors based on data analysis, if applicable. |\n| Visits Modeled | number | 123 | Modeled number of visits based on data analysis, if applicable. |\n| Leads Modeled | number | 123 | Modeled number of leads based on data analysis, if applicable. |\n| Installs Modeled | number | 123 | Modeled number of app installations based on data analysis, if applicable. |\n| Signups Modeled | number | 123 | Modeled number of signups based on data analysis, if applicable. |\n| Purchases Modeled | number | 123 | Modeled number of purchases based on data analysis, if applicable. |\n| Revenue Modeled | number | 123 | Modeled revenue based on data analysis, if applicable. |\n| Promo codes | number | 123 | Number of times promo codes associated with the ad were used, if applicable. |\n| Clicks | number | 123 | How many times link was clicked. |\n| Campaign ID | string | some-campaign-id | Identifier for the advertising campaign. |\n| Campaign Internal ID | string | mycampaign | The campaign's identifier in Podscribe. |\n| Podscribe Campaign ID | string | 3105cc60-3970-11f1-a827-67ac2fdfebc6 | Unique Podscribe campaign request ID. |\n| Publisher ID | string | 123 | Podscribe publisher ID. |\n| Product | string | some-product | The product name. |\n| Initiative | string | some-initiative | The initiative name. |\n| Business Line | string | some-business-line | The business line name. |\n| Rumble Impressions | number | 123 | Number of Rumble impressions, if applicable. |\n| Spotify Video Impressions | number | 123 | Number of Spotify video impressions, if applicable. |\n| Episode GUID | string | episode-guid | Guid of the episode |\n| Episode ID | number | 123 | Podscribe ID of the episode, if applicable. |\n| Campaign Promo | string | SALE20 | A string value representing a promotional code associated with a campaign |\n| Campaign Geo | string | United States | Name of the campaign country |\n| Incremental Visitors | number | 123 | Incremental visitors vs holdout. Requires `showIncrementalResults`. |\n| Incremental Visitors Modeled | number | 123 | Modeled incremental visitors. Requires `showIncrementalResults`. |\n| Visitors Campaign Incremental % | number | 0.05 | Campaign-level visitors incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Visitors Channel Incremental % | number | 0.05 | Channel-level visitors incrementality. Requires `showIncrementalResults`. |\n| Incremental Leads | number | 123 | Incremental leads vs holdout. Requires `showIncrementalResults`. |\n| Incremental Leads Modeled | number | 123 | Modeled incremental leads. Requires `showIncrementalResults`. |\n| Leads Campaign Incremental % | number | 0.05 | Campaign-level leads incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Leads Channel Incremental % | number | 0.05 | Channel-level leads incrementality. Requires `showIncrementalResults`. |\n| Incremental Installs | number | 123 | Incremental installs vs holdout. Requires `showIncrementalResults`. |\n| Incremental Installs Modeled | number | 123 | Modeled incremental installs. Requires `showIncrementalResults`. |\n| Installs Campaign Incremental % | number | 0.05 | Campaign-level installs incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Installs Channel Incremental % | number | 0.05 | Channel-level installs incrementality. Requires `showIncrementalResults`. |\n| Incremental Signups | number | 123 | Incremental signups vs holdout. Requires `showIncrementalResults`. |\n| Incremental Signups Modeled | number | 123 | Modeled incremental signups. Requires `showIncrementalResults`. |\n| Signups Campaign Incremental % | number | 0.05 | Campaign-level signups incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Signups Channel Incremental % | number | 0.05 | Channel-level signups incrementality. Requires `showIncrementalResults`. |\n| Incremental Purchases | number | 123 | Incremental purchases vs holdout. Requires `showIncrementalResults`. |\n| Incremental Purchases Modeled | number | 123 | Modeled incremental purchases. Requires `showIncrementalResults`. |\n| Purchases Campaign Incremental % | number | 0.05 | Campaign-level purchases incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Purchases Channel Incremental % | number | 0.05 | Channel-level purchases incrementality. Requires `showIncrementalResults`. |\n| Incremental Visits | number | 123 | Incremental visits vs holdout. Requires `showIncrementalResults`. |\n| Incremental Visits Modeled | number | 123 | Modeled incremental visits. Requires `showIncrementalResults`. |\n| Visits Campaign Incremental % | number | 0.05 | Campaign-level visits incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Visits Channel Incremental % | number | 0.05 | Channel-level visits incrementality. Requires `showIncrementalResults`. |\n| Incremental Revenue | number | 123 | Incremental revenue vs holdout. Requires `showIncrementalResults`. |\n| Incremental Revenue Modeled | number | 123 | Modeled incremental revenue. Requires `showIncrementalResults`. |\n| Downloads Incremental | number | 123 | Incremental downloads. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Incremental Modeled | number | 123 | Modeled incremental downloads. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Campaign Incremental % | number | 0.05 | Campaign-level downloads incrementality. Smart promo reports only. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Downloads Channel Incremental % | number | 0.05 | Channel-level downloads incrementality. Smart promo reports only. Requires `showIncrementalResults`. |\n| Campaign Start Date | string | 2015-03-19 | Campaign start date in the format YYYY-mm-DD |\n| Campaign End Date | string | 2015-03-19 | Campaign end date in the format YYYY-mm-DD |\n| Campaign Expected Date| string | 2015-03-19 | Campaign expected date in the format YYYY-mm-DD |\n| Campaign Spend | number | 5000 | Booked cost of the campaign flight, or Podscribe's estimate when no rate is set. Blank for flights priced by CPM. Unlike Spend, this is planned rather than delivered. Excluded by default; request via `fields`. |\n| Expected Impressions | number | 250000 | Number of impressions the campaign flight was booked to deliver, as opposed to the delivered impression columns. Excluded by default; request via `fields`. |\n| Adswizz Campaign ID | string | 12345 | Adswizz campaign ID from pixel params (Adswizz platforms: adswizz, streaming_adswizz, adswizz_ron, streaming_adswizz_simple). Only populated when the column is requested and impressions were served via Adswizz. |\n| eCPM | number | 12.5 | Estimated cost per thousand impressions. Excluded by default; request via `fields`. |\n| CPM | number | 10 | Cost per thousand impressions. Excluded by default; request via `fields`. |\n| Genre | string | Comedy | Genre of the show. Excluded by default; request via `fields`. |\n| Episode Duration | number | 3600 | Episode duration in seconds. Excluded by default; request via `fields`. |\n| Ad Servers | string | megaphone | Ad servers that served the impressions. Excluded by default; request via `fields`. |\n| Itunes ID | string | 123 | iTunes ID of the show. Hidden by default; request via `fields`. |\n| YouTube Channel / Playlist ID | string | UCxxxx | YouTube channel or playlist ID of the show. Hidden by default; request via `fields`. |\n| Campaign & Initiative | string | Campaign / Initiative | Combined campaign and initiative label. |\n| Campaign Unit | string | Mid | Booked campaign unit. Excluded by default; request via `fields`. |\n| Campaign Creatives | string | Creative A | Campaign creative names. Excluded by default; request via `fields`. |\n| Advertiser Industry | string | Retail | Advertiser industry. Excluded by default; request via `fields`. |\n| Offline Purchases | number | 12 | Offline purchase conversions. Excluded by default; request via `fields`. |\n| Online Purchases | number | 80 | Online purchase conversions. Excluded by default; request via `fields`. |\n| Offline Purchases Modeled | number | 12 | Modeled offline purchase conversions. Excluded by default; request via `fields`. |\n| Online Purchases Modeled | number | 80 | Modeled online purchase conversions. Excluded by default; request via `fields`. |\n| Offline Revenue | number | 400 | Offline revenue. Excluded by default; request via `fields`. |\n| Online Revenue | number | 3200 | Online revenue. Excluded by default; request via `fields`. |\n| Offline Revenue Modeled | number | 400 | Modeled offline revenue. Excluded by default; request via `fields`. |\n| Online Revenue Modeled | number | 3200 | Modeled online revenue. Excluded by default; request via `fields`. |\n| Bill To | string | Agency | Billing account. Excluded by default; request via `fields`. |\n| Campaign Delivery Issues | string | WRONG GEO | Campaign delivery issue flags. Excluded by default; request via `fields`. Not available for limited-overview API keys. |\n| Campaign Placement Issues | string | STALE READ | Campaign placement issue flags. Excluded by default; request via `fields`. Not available for limited-overview API keys. |\n| YouTube Engaged Views | number | 123 | Engaged YouTube views when Engaged Views is enabled. Hidden by default; request via `fields`. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "campaign-show-impressions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"timeGrouping\": \"day\",\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"fields\": [\n \"Week\",\n \"Day\",\n \"Advertiser\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Promo codes\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"ytSimulcastConv\": true,\n \"ytSimulcastConvWeight\": 1,\n \"rSimulcastConvWeight\": 0.7,\n \"svSimulcastConvWeight\": 0.7,\n \"includeYtSpend\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"incCiCertainty\": 95,\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false,\n \"modelPublicSpaceIps\": true,\n \"modelOffline\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "31aaec3d-b5e1-4f7b-b37a-399e999c8073", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "campaign-show-impressions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"timeGrouping\": \"day\",\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"fields\": [\n \"Week\",\n \"Day\",\n \"Advertiser\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Promo codes\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"ytSimulcastConv\": true,\n \"ytSimulcastConvWeight\": 1,\n \"rSimulcastConvWeight\": 0.7,\n \"svSimulcastConvWeight\": 0.7,\n \"includeYtSpend\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"incCiCertainty\": 95,\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false,\n \"modelPublicSpaceIps\": true,\n \"modelOffline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7716f48-cb39-4e6f-b29a-71a630e3bf32", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "campaign-show-impressions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"timeGrouping\": \"day\",\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"fields\": [\n \"Week\",\n \"Day\",\n \"Advertiser\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Promo codes\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"ytSimulcastConv\": true,\n \"ytSimulcastConvWeight\": 1,\n \"rSimulcastConvWeight\": 0.7,\n \"svSimulcastConvWeight\": 0.7,\n \"includeYtSpend\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"incCiCertainty\": 95,\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false,\n \"modelPublicSpaceIps\": true,\n \"modelOffline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e361aba3-6c83-4f0d-b1e3-b864b65c4b03", "name": "Forbidden (invalid token, no API access, or no show-level reporting access)", "originalRequest": { "url": { "path": [ "api", "public", "campaign-show-impressions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"timeGrouping\": \"day\",\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"fields\": [\n \"Week\",\n \"Day\",\n \"Advertiser\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Promo codes\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"ytSimulcastConv\": true,\n \"ytSimulcastConvWeight\": 1,\n \"rSimulcastConvWeight\": 0.7,\n \"svSimulcastConvWeight\": 0.7,\n \"includeYtSpend\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"incCiCertainty\": 95,\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false,\n \"modelPublicSpaceIps\": true,\n \"modelOffline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2af096b9-a256-4bd9-b04f-24d46859e850", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "campaign-show-impressions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"timeGrouping\": \"day\",\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"fields\": [\n \"Week\",\n \"Day\",\n \"Advertiser\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Promo codes\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"ytSimulcastConv\": true,\n \"ytSimulcastConvWeight\": 1,\n \"rSimulcastConvWeight\": 0.7,\n \"svSimulcastConvWeight\": 0.7,\n \"includeYtSpend\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"incCiCertainty\": 95,\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false,\n \"modelPublicSpaceIps\": true,\n \"modelOffline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9f6c64f-653d-46e8-8fa0-1b474e3c1062", "name": "Custom Grouping", "request": { "name": "Custom Grouping", "description": { "content": "Generate a CSV with a combination of reporting dimensions. Supports the reporting filters and attribution settings used by other CSV reports.\n`publisher` groups by the publisher assigned to the purchase, as in By Publisher, not the publisher received in a pixel.\nFor Show groupings, Publisher and Publisher ID identify publishers assigned to contributing purchases for that Show or Episode, including run-of-network delivery. When no purchase is resolved, Publisher falls back to the Show's publisher.\n`app` groups by the listener application. Missing App and Device values are exported as Unknown; delivery remains in its original group.\nSelected dimensions add CSV columns: Campaign, Show, Episode, Publisher, Creative ID, App, Device, Country, Region, DMA and ZIP.\nWhen Show is selected, Show ID is included by default at the end of the columns. An explicit fields list controls whether Show ID is included.\nCampaign grouped with one location dimension uses the Geo column. The UI selects this column by default; an explicit fields list controls its inclusion.\nCampaign and Publisher grouping combines delivery and spend in one row per selected campaign, publisher and time period. Summed spend is rounded to two decimal places.\nCreative grouping also appends Creative Name to the CSV. It contains the saved creative name, or the Creative ID when no name is available.\nCreative Name respects column selection through `fields` and renaming through `fieldMapping`, including Campaign + Creative reports.\nMetrics retain their existing CSV names, including Spend, Podcast & Streaming Impressions and optional Delivered Contracted Impressions.\nThe response is a file-processing task. Poll its status and download the completed CSV.\nRequests are subject to a report complexity limit based on the selected dimensions, date range and time grouping. Episode + ZIP combinations also account for the selected Campaign and Episode filters and the largest time period being calculated. Narrowing inclusion filters can reduce complexity; excluding campaigns does not reduce this estimate. Requesting Delivered Contracted Impressions can increase complexity.\nIf the limit is exceeded, the endpoint returns HTTP 400. Shorten the date range, select fewer Campaigns or Episodes, or remove some column groupings before retrying.", "type": "text/plain" }, "url": { "path": [ "api", "public", "reports", "custom-grouping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"groupings\": [\n \"zip\"\n ],\n \"advertiser\": [\n \"string\",\n \"string\"\n ],\n \"startDate\": \"2006-08-22\",\n \"endDate\": \"1950-01-09\",\n \"timeGrouping\": \"month\",\n \"aggregateEpisodicBuysPerShow\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5d19f339-aa65-4afc-b174-5267d5887f2f", "name": "File-processing task created or reused.", "originalRequest": { "url": { "path": [ "api", "public", "reports", "custom-grouping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"groupings\": [\n \"app\"\n ],\n \"advertiser\": [\n \"string\",\n \"string\"\n ],\n \"startDate\": \"2015-03-12\",\n \"endDate\": \"2006-09-19\",\n \"timeGrouping\": \"all\",\n \"aggregateEpisodicBuysPerShow\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"status\": \"string\",\n \"url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2fef60a-2f83-4559-a8cb-84468b70ce3e", "name": "Invalid report parameters or report complexity limit exceeded.", "originalRequest": { "url": { "path": [ "api", "public", "reports", "custom-grouping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"groupings\": [\n \"app\"\n ],\n \"advertiser\": [\n \"string\",\n \"string\"\n ],\n \"startDate\": \"2015-03-12\",\n \"endDate\": \"2006-09-19\",\n \"timeGrouping\": \"all\",\n \"aggregateEpisodicBuysPerShow\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"This report is too complex to generate. Shorten the date range, select fewer Campaigns or Episodes, or remove some column groupings. Delivered Contracted Impressions requires daily calculation even for Aggregate reports.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3bc8e8db-148b-4dd9-9de7-f7021d136a3d", "name": "By Creative", "request": { "name": "By Creative", "description": { "content": "Impressions, spend and attribution per creative and publisher.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|-----------------------|----------|-----------------------|----------------------------------------------------------------------------------------------------------|\n| Week | string | 2023-12-18 | Date of the week in the format YYYY-mm-DD. |\n| Day | string | 2023-12-23 | Date of the day in the format YYYY-mm-DD. |\n| Advertiser | string | demoAdvertiser | Name of the advertiser for the media content. |\n| Creative ID | string | 1345805 | ID of the creative. |\n| Creative Name | string | My Creative | Human readable name of the creative. |\n| Media Type | string | podcast | Type of media content, such as \"podcast,\" \"podcast and youtube,\" \"youtube,\" \"simulcast,\" or \"streaming.\" |\n| Type | string | baked-in | Type of ad integration, either \"baked-in\" or \"dai\" (Dynamic Ad Insertion). |\n| Tags | string | Retail | Optional tags associated with the campaign. |\n| Spend | number | 123 | Amount spent on the advertisement, if applicable. |\n| Publisher | string | Some publisher | Name of the publisher or platform hosting the content. |\n| Campaign | string | My Campaign | Name of the advertising campaign. |\n| SmartServe Targeting Profile | string | My Profile | Name of the SmartServe targeting profile. Excluded by default; add \"SmartServe Targeting Profile\" to `fields` to include. Only populated for campaigns served via SmartServe. |\n| Show | string | Some Show | Name of the show associated with the media content. |\n| Show ID | number | 123 | Podscribe ID of the show. Excluded by default except for previously enabled advertisers; request via `fields`. |\n| Podcast & Streaming Impressions| number | 123 | Number of podcast & streaming impressions, if applicable. |\n| Delivered Contracted Impressions | number | 123 | DAI impressions within flight dates, capped by expected impressions. Hidden by default; request via `fields`. |\n| YouTube Views | number | 123 | Number of views for YouTube content, if applicable. |\n| Reach | number | 123 | Reach represents the total number of unique users who saw the ad. |\n| Visitors | number | 123 | Number of visitors to a website, if applicable. |\n| Visits | number | 123 | Number of visits to a website, if applicable. |\n| Leads | number | 123 | Number of leads generated, if applicable. |\n| Installs | number | 123 | Number of app installations, if applicable. |\n| Signups | number | 123 | Number of signups or registrations, if applicable. |\n| Purchases | number | 123 | Number of purchases made, if applicable. |\n| Revenue | number | 123 | Revenue generated, if applicable. |\n| Visitors Modeled | number | 123 | Modeled number of visitors based on data analysis, if applicable. |\n| Visits Modeled | number | 123 | Modeled number of visits based on data analysis, if applicable. |\n| Leads Modeled | number | 123 | Modeled number of leads based on data analysis, if applicable. |\n| Installs Modeled | number | 123 | Modeled number of app installations based on data analysis, if applicable. |\n| Signups Modeled | number | 123 | Modeled number of signups based on data analysis, if applicable. |\n| Purchases Modeled | number | 123 | Modeled number of purchases based on data analysis, if applicable. |\n| Revenue Modeled | number | 123 | Modeled revenue based on data analysis, if applicable. |\n| Clicks | number | 123 | How many times link was clicked. |\n| Campaign ID | string | some-campaign-id | Identifier for the advertising campaign. |\n| Campaign Internal ID | string | mycampaign | The campaign's identifier in Podscribe. |\n| Podscribe Campaign ID | string | 3105cc60-3970-11f1-a827-67ac2fdfebc6 | Unique Podscribe campaign request ID. |\n| Publisher ID | string | 123 | Podscribe publisher ID. Empty when the publisher is not a Podscribe publisher. |\n| Product | string | some-product | The product name. |\n| Initiative | string | some-initiative | The initiative name. |\n| Business Line | string | some-business-line | The business line name. |\n| Rumble Impressions | number | 123 | Number of Rumble impressions, if applicable. |\n| Spotify Video Impressions | number | 123 | Number of Spotify video impressions, if applicable. |\n| Campaign Promo | string | SALE20 | A string value representing a promotional code associated with a campaign |\n| Incremental Visitors | number | 123 | Incremental visitors vs holdout. Requires `showIncrementalResults`. |\n| Incremental Visitors % | number | 0.05 | Incremental visitors as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Visitors Modeled | number | 123 | Modeled incremental visitors. Requires `showIncrementalResults`. |\n| Incremental Visitors Modeled % | number | 0.05 | Modeled incremental visitors as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors Campaign Incremental % | number | 0.05 | Campaign-level visitors incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Visitors Channel Incremental % | number | 0.05 | Channel-level visitors incrementality. Requires `showIncrementalResults`. |\n| Incremental Leads | number | 123 | Incremental leads vs holdout. Requires `showIncrementalResults`. |\n| Incremental Leads % | number | 0.05 | Incremental leads as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Leads Modeled | number | 123 | Modeled incremental leads. Requires `showIncrementalResults`. |\n| Incremental Leads Modeled % | number | 0.05 | Modeled incremental leads as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads Campaign Incremental % | number | 0.05 | Campaign-level leads incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Leads Channel Incremental % | number | 0.05 | Channel-level leads incrementality. Requires `showIncrementalResults`. |\n| Incremental Installs | number | 123 | Incremental installs vs holdout. Requires `showIncrementalResults`. |\n| Incremental Installs % | number | 0.05 | Incremental installs as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Installs Modeled | number | 123 | Modeled incremental installs. Requires `showIncrementalResults`. |\n| Incremental Installs Modeled % | number | 0.05 | Modeled incremental installs as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs Campaign Incremental % | number | 0.05 | Campaign-level installs incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Installs Channel Incremental % | number | 0.05 | Channel-level installs incrementality. Requires `showIncrementalResults`. |\n| Incremental Signups | number | 123 | Incremental signups vs holdout. Requires `showIncrementalResults`. |\n| Incremental Signups % | number | 0.05 | Incremental signups as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Signups Modeled | number | 123 | Modeled incremental signups. Requires `showIncrementalResults`. |\n| Incremental Signups Modeled % | number | 0.05 | Modeled incremental signups as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups Campaign Incremental % | number | 0.05 | Campaign-level signups incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Signups Channel Incremental % | number | 0.05 | Channel-level signups incrementality. Requires `showIncrementalResults`. |\n| Incremental Purchases | number | 123 | Incremental purchases vs holdout. Requires `showIncrementalResults`. |\n| Incremental Purchases % | number | 0.05 | Incremental purchases as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Purchases Modeled | number | 123 | Modeled incremental purchases. Requires `showIncrementalResults`. |\n| Incremental Purchases Modeled % | number | 0.05 | Modeled incremental purchases as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases Campaign Incremental % | number | 0.05 | Campaign-level purchases incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Purchases Channel Incremental % | number | 0.05 | Channel-level purchases incrementality. Requires `showIncrementalResults`. |\n| Incremental Visits | number | 123 | Incremental visits vs holdout. Requires `showIncrementalResults`. |\n| Incremental Visits % | number | 0.05 | Incremental visits as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Visits Modeled | number | 123 | Modeled incremental visits. Requires `showIncrementalResults`. |\n| Incremental Visits Modeled % | number | 0.05 | Modeled incremental visits as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits Campaign Incremental % | number | 0.05 | Campaign-level visits incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Visits Channel Incremental % | number | 0.05 | Channel-level visits incrementality. Requires `showIncrementalResults`. |\n| Incremental Revenue | number | 123 | Incremental revenue vs holdout. Requires `showIncrementalResults`. |\n| Incremental Revenue Modeled | number | 123 | Modeled incremental revenue. Requires `showIncrementalResults`. |\n| Downloads Incremental | number | 123 | Incremental downloads. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Incremental Modeled | number | 123 | Modeled incremental downloads. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Campaign Incremental % | number | 0.05 | Campaign-level downloads incrementality. Smart promo reports only. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Downloads Channel Incremental % | number | 0.05 | Channel-level downloads incrementality. Smart promo reports only. Requires `showIncrementalResults`. |\n| Campaign Start Date | string | 2015-03-19 | Campaign start date in the format YYYY-mm-DD |\n| Campaign End Date | string | 2015-03-19 | Campaign end date in the format YYYY-mm-DD |\n| Campaign Expected Date| string | 2015-03-19 | Campaign expected date in the format YYYY-mm-DD |\n| Adswizz Campaign ID | string | 12345 | Adswizz campaign ID from pixel params (Adswizz platforms: adswizz, streaming_adswizz, adswizz_ron, streaming_adswizz_simple). Only populated when the column is requested and impressions were served via Adswizz. |\n| Month | string | 2023-12-01 | First day of the month in YYYY-mm-DD. Present when `timeGrouping` is `month`. |\n| Live Date | string | 2023-12-18 | Live date of the creative. Excluded by default; request via `fields`. |\n| eCPM | number | 12.5 | Estimated cost per thousand impressions. Excluded by default; request via `fields`. |\n| CPM | number | 10 | Cost per thousand impressions. Excluded by default; request via `fields`. |\n| Genre | string | Comedy | Genre of the show. Excluded by default; request via `fields`. |\n| Frequency | number | 1.5 | Average impressions per unique listener. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors % | number | 0.05 | Visitors as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits % | number | 0.04 | Visits as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads % | number | 0.01 | Leads as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs % | number | 0.01 | Installs as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups % | number | 0.02 | Signups as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases % | number | 0.02 | Purchases as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors Modeled % | number | 0.05 | Modeled visitors as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits Modeled % | number | 0.04 | Modeled visits as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads Modeled % | number | 0.01 | Modeled leads as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs Modeled % | number | 0.01 | Modeled installs as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups Modeled % | number | 0.02 | Modeled signups as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases Modeled % | number | 0.02 | Modeled purchases as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| ROAS | number | 2.5 | Return on advertising spend. Available when `timeGrouping` is `all`. |\n| ROAS Modeled | number | 2.5 | Modeled return on advertising spend. Available when `timeGrouping` is `all`. |\n| AOV | number | 45 | Average order value. Available when `timeGrouping` is `all`. |\n| AOV Modeled | number | 45 | Modeled average order value. Available when `timeGrouping` is `all`. |\n| Cost Per Visitor | number | 12 | Spend divided by visitors. Available when `timeGrouping` is `all`. |\n| Cost Per Visitor Modeled | number | 12 | Spend divided by modeled visitors. Available when `timeGrouping` is `all`. |\n| Cost Per Lead | number | 20 | Spend divided by leads. Available when `timeGrouping` is `all`. |\n| Cost Per Lead Modeled | number | 20 | Spend divided by modeled leads. Available when `timeGrouping` is `all`. |\n| Cost Per Install | number | 25 | Spend divided by installs. Available when `timeGrouping` is `all`. |\n| Cost Per Install Modeled | number | 25 | Spend divided by modeled installs. Available when `timeGrouping` is `all`. |\n| Cost Per Signup | number | 18 | Spend divided by signups. Available when `timeGrouping` is `all`. |\n| Cost Per Signup Modeled | number | 18 | Spend divided by modeled signups. Available when `timeGrouping` is `all`. |\n| Cost Per Purchase | number | 30 | Spend divided by purchases. Available when `timeGrouping` is `all`. |\n| Cost Per Purchase Modeled | number | 30 | Spend divided by modeled purchases. Available when `timeGrouping` is `all`. |\n| Cost Per Incremental Visitor | number | 12 | Spend divided by incremental visitors. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Visitor Modeled | number | 12 | Spend divided by modeled incremental visitors. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Lead | number | 20 | Spend divided by incremental leads. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Lead Modeled | number | 20 | Spend divided by modeled incremental leads. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Install | number | 25 | Spend divided by incremental installs. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Install Modeled | number | 25 | Spend divided by modeled incremental installs. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Signup | number | 18 | Spend divided by incremental signups. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Signup Modeled | number | 18 | Spend divided by modeled incremental signups. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Purchase | number | 30 | Spend divided by incremental purchases. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Purchase Modeled | number | 30 | Spend divided by modeled incremental purchases. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental ROAS | number | 2.5 | Incremental return on advertising spend. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental ROAS Modeled | number | 2.5 | Modeled incremental return on advertising spend. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Itunes ID | string | 123 | iTunes ID of the show. Hidden by default; request via `fields`. |\n| YouTube Channel / Playlist ID | string | UCxxxx | YouTube channel or playlist ID of the show. Hidden by default; request via `fields`. |\n| Campaign & Initiative | string | Campaign / Initiative | Combined campaign and initiative label. |\n| Campaign Unit | string | Mid | Booked campaign unit. Excluded by default; request via `fields`. |\n| Campaign Spend | number | 5000 | Booked cost of the campaign flight, or Podscribe's estimate when no rate is set. Blank for flights priced by CPM. Unlike Spend, this is planned rather than delivered. Excluded by default; request via `fields`. |\n| Expected Impressions | number | 250000 | Number of impressions the campaign flight was booked to deliver, as opposed to the delivered impression columns. Excluded by default; request via `fields`. |\n| Campaign Creatives | string | Creative A | Campaign creative names. Excluded by default; request via `fields`. |\n| Advertiser Industry | string | Retail | Advertiser industry. Excluded by default; request via `fields`. |\n| Offline Purchases | number | 12 | Offline purchase conversions. Excluded by default; request via `fields`. |\n| Online Purchases | number | 80 | Online purchase conversions. Excluded by default; request via `fields`. |\n| Offline Purchases Modeled | number | 12 | Modeled offline purchase conversions. Excluded by default; request via `fields`. |\n| Online Purchases Modeled | number | 80 | Modeled online purchase conversions. Excluded by default; request via `fields`. |\n| Offline Revenue | number | 400 | Offline revenue. Excluded by default; request via `fields`. |\n| Online Revenue | number | 3200 | Online revenue. Excluded by default; request via `fields`. |\n| Offline Revenue Modeled | number | 400 | Modeled offline revenue. Excluded by default; request via `fields`. |\n| Online Revenue Modeled | number | 3200 | Modeled online revenue. Excluded by default; request via `fields`. |\n| Bill To | string | Agency | Billing account. Excluded by default; request via `fields`. |\n| YouTube Engaged Views | number | 123 | Engaged YouTube views when Engaged Views is enabled. Hidden by default; request via `fields`. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "reports", "creative" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"fields\": [\n \"Advertiser\",\n \"Creative ID\",\n \"Creative Name\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"startDate\": \"1948-11-24\",\n \"endDate\": \"1999-04-26\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3bd39105-da58-478c-a457-571f1d67049c", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "reports", "creative" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"fields\": [\n \"Advertiser\",\n \"Creative ID\",\n \"Creative Name\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"startDate\": \"1965-08-03\",\n \"endDate\": \"2004-11-09\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d71caf5a-afbd-49a2-b165-e007720b2535", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "reports", "creative" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"fields\": [\n \"Advertiser\",\n \"Creative ID\",\n \"Creative Name\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"startDate\": \"1965-08-03\",\n \"endDate\": \"2004-11-09\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "58ff6ef0-dc63-4210-b574-0b816ab96025", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "reports", "creative" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"fields\": [\n \"Advertiser\",\n \"Creative ID\",\n \"Creative Name\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"startDate\": \"1965-08-03\",\n \"endDate\": \"2004-11-09\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d758911-706f-4447-89d1-3d6af4c4a6b3", "name": "By Campaign & Creative", "request": { "name": "By Campaign & Creative", "description": { "content": "Impressions, spend and attribution per campaign, episode and creative.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|-----------------------|----------|-----------------------|----------------------------------------------------------------------------------------------------------|\n| Week | string | 2023-12-18 | Date of the week in the format YYYY-mm-DD. |\n| Day | string | 2023-12-23 | Date of the day in the format YYYY-mm-DD. |\n| Advertiser | string | demoAdvertiser | Name of the advertiser for the media content. |\n| Creative ID | string | some-creative-id | ID of the creative. |\n| Media Type | string | podcast | Type of media content, such as \"podcast,\" \"podcast and youtube,\" \"youtube,\" \"simulcast,\" or \"streaming.\" |\n| Type | string | baked-in | Type of ad integration, either \"baked-in\" or \"dai\" (Dynamic Ad Insertion). |\n| Tags | string | Retail | Optional tags associated with the campaign. |\n| Spend | number | 123 | Amount spent on the advertisement, if applicable. |\n| Publisher | string | Some publisher | Name of the publisher or platform hosting the content. |\n| Campaign | string | My Campaign | Name of the advertising campaign. |\n| SmartServe Targeting Profile | string | My Profile | Name of the SmartServe targeting profile. Excluded by default; add \"SmartServe Targeting Profile\" to `fields` to include. Only populated for campaigns served via SmartServe. |\n| Show | string | Some Show | Name of the show associated with the media content. |\n| Show ID | number | 123 | Podscribe ID of the show. Excluded by default except for previously enabled advertisers; request via `fields`. |\n| Episode | string | Some Ep | Name or identifier of the specific episode, if applicable. |\n| Podcast & Streaming Impressions| number | 123 | Number of podcast & streaming impressions, if applicable. |\n| Delivered Contracted Impressions | number | 123 | DAI impressions within flight dates, capped by expected impressions. Hidden by default; request via `fields`. |\n| YouTube Views | number | 123 | Number of views for YouTube content, if applicable. |\n| Reach | number | 123 | Reach represents the total number of unique users who saw the ad. |\n| Visitors | number | 123 | Number of visitors to a website, if applicable. |\n| Visits | number | 123 | Number of visits to a website, if applicable. |\n| Leads | number | 123 | Number of leads generated, if applicable. |\n| Installs | number | 123 | Number of app installations, if applicable. |\n| Signups | number | 123 | Number of signups or registrations, if applicable. |\n| Purchases | number | 123 | Number of purchases made, if applicable. |\n| Revenue | number | 123 | Revenue generated, if applicable. |\n| Visitors Modeled | number | 123 | Modeled number of visitors based on data analysis, if applicable. |\n| Visits Modeled | number | 123 | Modeled number of visits based on data analysis, if applicable. |\n| Leads Modeled | number | 123 | Modeled number of leads based on data analysis, if applicable. |\n| Installs Modeled | number | 123 | Modeled number of app installations based on data analysis, if applicable. |\n| Signups Modeled | number | 123 | Modeled number of signups based on data analysis, if applicable. |\n| Purchases Modeled | number | 123 | Modeled number of purchases based on data analysis, if applicable. |\n| Revenue Modeled | number | 123 | Modeled revenue based on data analysis, if applicable. |\n| Clicks | number | 123 | How many times link was clicked. |\n| Campaign ID | string | some-campaign-id | Identifier for the advertising campaign. |\n| Campaign Internal ID | string | mycampaign | The campaign's identifier in Podscribe. |\n| Podscribe Campaign ID | string | 3105cc60-3970-11f1-a827-67ac2fdfebc6 | Unique Podscribe campaign request ID. |\n| Publisher ID | string | 123 | Podscribe publisher ID. |\n| Product | string | some-product | The product name. |\n| Initiative | string | some-initiative | The initiative name. |\n| Business Line | string | some-business-line | The business line name. |\n| Rumble Impressions | number | 123 | Number of Rumble impressions, if applicable. |\n| Spotify Video Impressions | number | 123 | Number of Spotify video impressions, if applicable. |\n| Episode ID | number | 123 | Podscribe ID of the episode, if applicable. |\n| Campaign Promo | string | SALE20 | A string value representing a promotional code associated with a campaign |\n| Campaign Geo | string | United States | Name of the campaign country |\n| Incrementality Source | string | Synthetic - Channel | Provenance of the row's incrementality values. Possible values: \"SmartServe\", \"SmartServe (PSA)\", \"SmartServe (Holdout)\", \"Synthetic - Campaign\", or \"Synthetic - Channel\". Excluded by default; explicitly add this field and enable `showIncrementalResults`. |\n| Incremental Visitors | number | 123 | Incremental visitors vs holdout. Requires `showIncrementalResults`. |\n| Incremental Visitors % | number | 0.05 | Incremental visitors as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Visitors Modeled | number | 123 | Modeled incremental visitors. Requires `showIncrementalResults`. |\n| Incremental Visitors Modeled % | number | 0.05 | Modeled incremental visitors as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors Campaign Incremental % | number | 0.05 | Campaign-level visitors incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Visitors Channel Incremental % | number | 0.05 | Channel-level visitors incrementality. Requires `showIncrementalResults`. |\n| Incremental Leads | number | 123 | Incremental leads vs holdout. Requires `showIncrementalResults`. |\n| Incremental Leads % | number | 0.05 | Incremental leads as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Leads Modeled | number | 123 | Modeled incremental leads. Requires `showIncrementalResults`. |\n| Incremental Leads Modeled % | number | 0.05 | Modeled incremental leads as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads Campaign Incremental % | number | 0.05 | Campaign-level leads incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Leads Channel Incremental % | number | 0.05 | Channel-level leads incrementality. Requires `showIncrementalResults`. |\n| Incremental Installs | number | 123 | Incremental installs vs holdout. Requires `showIncrementalResults`. |\n| Incremental Installs % | number | 0.05 | Incremental installs as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Installs Modeled | number | 123 | Modeled incremental installs. Requires `showIncrementalResults`. |\n| Incremental Installs Modeled % | number | 0.05 | Modeled incremental installs as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs Campaign Incremental % | number | 0.05 | Campaign-level installs incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Installs Channel Incremental % | number | 0.05 | Channel-level installs incrementality. Requires `showIncrementalResults`. |\n| Incremental Signups | number | 123 | Incremental signups vs holdout. Requires `showIncrementalResults`. |\n| Incremental Signups % | number | 0.05 | Incremental signups as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Signups Modeled | number | 123 | Modeled incremental signups. Requires `showIncrementalResults`. |\n| Incremental Signups Modeled % | number | 0.05 | Modeled incremental signups as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups Campaign Incremental % | number | 0.05 | Campaign-level signups incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Signups Channel Incremental % | number | 0.05 | Channel-level signups incrementality. Requires `showIncrementalResults`. |\n| Incremental Purchases | number | 123 | Incremental purchases vs holdout. Requires `showIncrementalResults`. |\n| Incremental Purchases % | number | 0.05 | Incremental purchases as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Purchases Modeled | number | 123 | Modeled incremental purchases. Requires `showIncrementalResults`. |\n| Incremental Purchases Modeled % | number | 0.05 | Modeled incremental purchases as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases Campaign Incremental % | number | 0.05 | Campaign-level purchases incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Purchases Channel Incremental % | number | 0.05 | Channel-level purchases incrementality. Requires `showIncrementalResults`. |\n| Incremental Visits | number | 123 | Incremental visits vs holdout. Requires `showIncrementalResults`. |\n| Incremental Visits % | number | 0.05 | Incremental visits as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Visits Modeled | number | 123 | Modeled incremental visits. Requires `showIncrementalResults`. |\n| Incremental Visits Modeled % | number | 0.05 | Modeled incremental visits as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits Campaign Incremental % | number | 0.05 | Campaign-level visits incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Visits Channel Incremental % | number | 0.05 | Channel-level visits incrementality. Requires `showIncrementalResults`. |\n| Incremental Revenue | number | 123 | Incremental revenue vs holdout. Requires `showIncrementalResults`. |\n| Incremental Revenue Modeled | number | 123 | Modeled incremental revenue. Requires `showIncrementalResults`. |\n| Visits Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level visits incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. |\n| Visits Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level visits incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. |\n| Visitors Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level visitors incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. |\n| Visitors Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level visitors incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. |\n| Signups Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level signups incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. |\n| Signups Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level signups incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. |\n| Purchases Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level purchases incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. |\n| Purchases Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level purchases incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. |\n| Installs Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level installs incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. |\n| Installs Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level installs incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. |\n| Leads Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level leads incrementality confidence interval. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. |\n| Leads Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level leads incrementality confidence interval. Requires `showIncrementalResults`. Excluded by default; request via `fields`. |\n| Downloads Incremental | number | 123 | Incremental downloads. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Incremental Modeled | number | 123 | Modeled incremental downloads. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Campaign Incremental % | number | 0.05 | Campaign-level downloads incrementality. Smart promo reports only. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Downloads Channel Incremental % | number | 0.05 | Channel-level downloads incrementality. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level downloads incrementality confidence interval. Smart promo reports only. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. |\n| Downloads Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level downloads incrementality confidence interval. Smart promo reports only. Requires `showIncrementalResults`. Excluded by default; request via `fields`. |\n| Conversions Campaign Confidence Interval (+/- range) | number | 0.02 | Campaign-level conversions incrementality confidence interval. Smart promo reports only. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. Excluded by default; request via `fields`. |\n| Conversions Channel Confidence Interval (+/- range) | number | 0.02 | Channel-level conversions incrementality confidence interval. Smart promo reports only. Requires `showIncrementalResults`. Excluded by default; request via `fields`. |\n| Campaign Start Date | string | 2015-03-19 | Campaign start date in the format YYYY-mm-DD |\n| Campaign End Date | string | 2015-03-19 | Campaign end date in the format YYYY-mm-DD |\n| Campaign Expected Date| string | 2015-03-19 | Campaign expected date in the format YYYY-mm-DD |\n| Adswizz Campaign ID | string | 12345 | Adswizz campaign ID from pixel params (Adswizz platforms: adswizz, streaming_adswizz, adswizz_ron, streaming_adswizz_simple). Only populated when the column is requested and impressions were served via Adswizz. |\n| Month | string | 2023-12-01 | First day of the month in YYYY-mm-DD. Present when `timeGrouping` is `month`. |\n| eCPM | number | 12.5 | Estimated cost per thousand impressions. Excluded by default; request via `fields`. |\n| CPM | number | 10 | Cost per thousand impressions. Excluded by default; request via `fields`. |\n| Genre | string | Comedy | Genre of the show. Excluded by default; request via `fields`. |\n| Episode Duration | number | 3600 | Episode duration in seconds. Excluded by default; request via `fields`. |\n| Ad Servers | string | megaphone | Ad servers that served the impressions. Excluded by default; request via `fields`. |\n| Publish Date | string | 2023-12-18 | Date when the media content was published, in the format YYYY-mm-DD. |\n| Frequency | number | 1.5 | Average impressions per unique listener. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors % | number | 0.05 | Visitors as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits % | number | 0.04 | Visits as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads % | number | 0.01 | Leads as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs % | number | 0.01 | Installs as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups % | number | 0.02 | Signups as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases % | number | 0.02 | Purchases as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors Modeled % | number | 0.05 | Modeled visitors as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits Modeled % | number | 0.04 | Modeled visits as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads Modeled % | number | 0.01 | Modeled leads as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs Modeled % | number | 0.01 | Modeled installs as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups Modeled % | number | 0.02 | Modeled signups as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases Modeled % | number | 0.02 | Modeled purchases as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| ROAS | number | 2.5 | Return on advertising spend. Available when `timeGrouping` is `all`. |\n| ROAS Modeled | number | 2.5 | Modeled return on advertising spend. Available when `timeGrouping` is `all`. |\n| AOV | number | 45 | Average order value. Available when `timeGrouping` is `all`. |\n| AOV Modeled | number | 45 | Modeled average order value. Available when `timeGrouping` is `all`. |\n| Cost Per Visitor | number | 12 | Spend divided by visitors. Available when `timeGrouping` is `all`. |\n| Cost Per Visitor Modeled | number | 12 | Spend divided by modeled visitors. Available when `timeGrouping` is `all`. |\n| Cost Per Lead | number | 20 | Spend divided by leads. Available when `timeGrouping` is `all`. |\n| Cost Per Lead Modeled | number | 20 | Spend divided by modeled leads. Available when `timeGrouping` is `all`. |\n| Cost Per Install | number | 25 | Spend divided by installs. Available when `timeGrouping` is `all`. |\n| Cost Per Install Modeled | number | 25 | Spend divided by modeled installs. Available when `timeGrouping` is `all`. |\n| Cost Per Signup | number | 18 | Spend divided by signups. Available when `timeGrouping` is `all`. |\n| Cost Per Signup Modeled | number | 18 | Spend divided by modeled signups. Available when `timeGrouping` is `all`. |\n| Cost Per Purchase | number | 30 | Spend divided by purchases. Available when `timeGrouping` is `all`. |\n| Cost Per Purchase Modeled | number | 30 | Spend divided by modeled purchases. Available when `timeGrouping` is `all`. |\n| Cost Per Incremental Visitor | number | 12 | Spend divided by incremental visitors. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Visitor Modeled | number | 12 | Spend divided by modeled incremental visitors. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Lead | number | 20 | Spend divided by incremental leads. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Lead Modeled | number | 20 | Spend divided by modeled incremental leads. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Install | number | 25 | Spend divided by incremental installs. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Install Modeled | number | 25 | Spend divided by modeled incremental installs. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Signup | number | 18 | Spend divided by incremental signups. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Signup Modeled | number | 18 | Spend divided by modeled incremental signups. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Purchase | number | 30 | Spend divided by incremental purchases. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Purchase Modeled | number | 30 | Spend divided by modeled incremental purchases. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental ROAS | number | 2.5 | Incremental return on advertising spend. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental ROAS Modeled | number | 2.5 | Modeled incremental return on advertising spend. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Itunes ID | string | 123 | iTunes ID of the show. Hidden by default; request via `fields`. |\n| YouTube Channel / Playlist ID | string | UCxxxx | YouTube channel or playlist ID of the show. Hidden by default; request via `fields`. |\n| Episode GUID | string | episode-guid | Guid of the episode. |\n| Campaign & Initiative | string | Campaign / Initiative | Combined campaign and initiative label. |\n| Campaign Unit | string | Mid | Booked campaign unit. Excluded by default; request via `fields`. |\n| Campaign Spend | number | 5000 | Booked cost of the campaign flight, or Podscribe's estimate when no rate is set. Blank for flights priced by CPM. Unlike Spend, this is planned rather than delivered. Excluded by default; request via `fields`. |\n| Expected Impressions | number | 250000 | Number of impressions the campaign flight was booked to deliver, as opposed to the delivered impression columns. Excluded by default; request via `fields`. |\n| Campaign Creatives | string | Creative A | Campaign creative names. Excluded by default; request via `fields`. |\n| Advertiser Industry | string | Retail | Advertiser industry. Excluded by default; request via `fields`. |\n| Offline Purchases | number | 12 | Offline purchase conversions. Excluded by default; request via `fields`. |\n| Online Purchases | number | 80 | Online purchase conversions. Excluded by default; request via `fields`. |\n| Offline Purchases Modeled | number | 12 | Modeled offline purchase conversions. Excluded by default; request via `fields`. |\n| Online Purchases Modeled | number | 80 | Modeled online purchase conversions. Excluded by default; request via `fields`. |\n| Offline Revenue | number | 400 | Offline revenue. Excluded by default; request via `fields`. |\n| Online Revenue | number | 3200 | Online revenue. Excluded by default; request via `fields`. |\n| Offline Revenue Modeled | number | 400 | Modeled offline revenue. Excluded by default; request via `fields`. |\n| Online Revenue Modeled | number | 3200 | Modeled online revenue. Excluded by default; request via `fields`. |\n| Bill To | string | Agency | Billing account. Excluded by default; request via `fields`. |\n| Campaign Delivery Issues | string | WRONG GEO | Campaign delivery issue flags. Excluded by default; request via `fields`. Not available for limited-overview API keys. |\n| Campaign Placement Issues | string | STALE READ | Campaign placement issue flags. Excluded by default; request via `fields`. Not available for limited-overview API keys. |\n| YouTube Engaged Views | number | 123 | Engaged YouTube views when Engaged Views is enabled. Hidden by default; request via `fields`. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "reports", "by-campaign", "creative" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Advertiser\",\n \"Creative ID\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"1993-02-20\",\n \"endDate\": \"1997-07-21\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "113d25f8-ee3d-4393-8df6-a78d752524d7", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "reports", "by-campaign", "creative" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Advertiser\",\n \"Creative ID\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"2014-03-09\",\n \"endDate\": \"2014-01-22\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdb40178-c02a-4fc7-9945-867f2692f48e", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "reports", "by-campaign", "creative" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Advertiser\",\n \"Creative ID\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"2014-03-09\",\n \"endDate\": \"2014-01-22\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8057915-8c43-4bcc-bf5e-388bbd1d6063", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "reports", "by-campaign", "creative" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Advertiser\",\n \"Creative ID\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"2014-03-09\",\n \"endDate\": \"2014-01-22\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd53926c-fbb4-440a-af5d-804091a8d09c", "name": "By Campaign & Device", "request": { "name": "By Campaign & Device", "description": { "content": "Impressions, spend and attribution per campaign, episode and device.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|-----------------------|----------|-----------------------|----------------------------------------------------------------------------------------------------------|\n| Week | string | 2023-12-18 | Date of the week in the format YYYY-mm-DD. |\n| Day | string | 2023-12-23 | Date of the day in the format YYYY-mm-DD. |\n| Advertiser | string | demoAdvertiser | Name of the advertiser for the media content. |\n| Device | string | Apple IPhone | Name of the device. |\n| Delivered Contracted Impressions | number | 123 | DAI impressions for flights with a rate or CPM, capped by contracted impressions within flight dates. Shared delivery counts once. Optional via `fields`. |\n| Media Type | string | podcast | Type of media content, such as \"podcast,\" \"podcast and youtube,\" \"youtube,\" \"simulcast,\" or \"streaming.\" |\n| Type | string | baked-in | Type of ad integration, either \"baked-in\" or \"dai\" (Dynamic Ad Insertion). |\n| Tags | string | Retail | Optional tags associated with the campaign. |\n| Spend | number | 123 | Amount spent on the advertisement, if applicable. |\n| Publisher | string | Some publisher | Name of the publisher or platform hosting the content. |\n| Campaign | string | My Campaign | Name of the advertising campaign. |\n| SmartServe Targeting Profile | string | My Profile | Name of the SmartServe targeting profile. Excluded by default; add \"SmartServe Targeting Profile\" to `fields` to include. Only populated for campaigns served via SmartServe. |\n| Show | string | Some Show | Name of the show associated with the media content. |\n| Show ID | number | 123 | Podscribe ID of the show. Excluded by default except for previously enabled advertisers; request via `fields`. |\n| Episode | string | Some Ep | Name or identifier of the specific episode, if applicable. |\n| Podcast & Streaming Impressions| number | 123 | Number of podcast & streaming impressions, if applicable. |\n| YouTube Views | number | 123 | Number of views for YouTube content, if applicable. |\n| Reach | number | 123 | Reach represents the total number of unique users who saw the ad. |\n| Visitors | number | 123 | Number of visitors to a website, if applicable. |\n| Visits | number | 123 | Number of visits to a website, if applicable. |\n| Leads | number | 123 | Number of leads generated, if applicable. |\n| Installs | number | 123 | Number of app installations, if applicable. |\n| Signups | number | 123 | Number of signups or registrations, if applicable. |\n| Purchases | number | 123 | Number of purchases made, if applicable. |\n| Revenue | number | 123 | Revenue generated, if applicable. |\n| Visitors Modeled | number | 123 | Modeled number of visitors based on data analysis, if applicable. |\n| Visits Modeled | number | 123 | Modeled number of visits based on data analysis, if applicable. |\n| Leads Modeled | number | 123 | Modeled number of leads based on data analysis, if applicable. |\n| Installs Modeled | number | 123 | Modeled number of app installations based on data analysis, if applicable. |\n| Signups Modeled | number | 123 | Modeled number of signups based on data analysis, if applicable. |\n| Purchases Modeled | number | 123 | Modeled number of purchases based on data analysis, if applicable. |\n| Revenue Modeled | number | 123 | Modeled revenue based on data analysis, if applicable. |\n| Clicks | number | 123 | How many times link was clicked. |\n| Campaign ID | string | some-campaign-id | Identifier for the advertising campaign. |\n| Campaign Internal ID | string | mycampaign | The campaign's identifier in Podscribe. |\n| Podscribe Campaign ID | string | 3105cc60-3970-11f1-a827-67ac2fdfebc6 | Unique Podscribe campaign request ID. |\n| Publisher ID | string | 123 | Podscribe publisher ID. |\n| Product | string | some-product | The product name. |\n| Initiative | string | some-initiative | The initiative name. |\n| Business Line | string | some-business-line | The business line name. |\n| Rumble Impressions | number | 123 | Number of Rumble impressions, if applicable. |\n| Spotify Video Impressions | number | 123 | Number of Spotify video impressions, if applicable. |\n| Episode ID | number | 123 | Podscribe ID of the episode, if applicable. |\n| Campaign Promo | string | SALE20 | A string value representing a promotional code associated with a campaign |\n| Campaign Geo | string | United States | Name of the campaign country |\n| Incremental Visitors | number | 123 | Incremental visitors vs holdout. Requires `showIncrementalResults`. |\n| Incremental Visitors % | number | 0.05 | Incremental visitors as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Visitors Modeled | number | 123 | Modeled incremental visitors. Requires `showIncrementalResults`. |\n| Incremental Visitors Modeled % | number | 0.05 | Modeled incremental visitors as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors Campaign Incremental % | number | 0.05 | Campaign-level visitors incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Visitors Channel Incremental % | number | 0.05 | Channel-level visitors incrementality. Requires `showIncrementalResults`. |\n| Incremental Leads | number | 123 | Incremental leads vs holdout. Requires `showIncrementalResults`. |\n| Incremental Leads % | number | 0.05 | Incremental leads as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Leads Modeled | number | 123 | Modeled incremental leads. Requires `showIncrementalResults`. |\n| Incremental Leads Modeled % | number | 0.05 | Modeled incremental leads as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads Campaign Incremental % | number | 0.05 | Campaign-level leads incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Leads Channel Incremental % | number | 0.05 | Channel-level leads incrementality. Requires `showIncrementalResults`. |\n| Incremental Installs | number | 123 | Incremental installs vs holdout. Requires `showIncrementalResults`. |\n| Incremental Installs % | number | 0.05 | Incremental installs as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Installs Modeled | number | 123 | Modeled incremental installs. Requires `showIncrementalResults`. |\n| Incremental Installs Modeled % | number | 0.05 | Modeled incremental installs as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs Campaign Incremental % | number | 0.05 | Campaign-level installs incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Installs Channel Incremental % | number | 0.05 | Channel-level installs incrementality. Requires `showIncrementalResults`. |\n| Incremental Signups | number | 123 | Incremental signups vs holdout. Requires `showIncrementalResults`. |\n| Incremental Signups % | number | 0.05 | Incremental signups as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Signups Modeled | number | 123 | Modeled incremental signups. Requires `showIncrementalResults`. |\n| Incremental Signups Modeled % | number | 0.05 | Modeled incremental signups as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups Campaign Incremental % | number | 0.05 | Campaign-level signups incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Signups Channel Incremental % | number | 0.05 | Channel-level signups incrementality. Requires `showIncrementalResults`. |\n| Incremental Purchases | number | 123 | Incremental purchases vs holdout. Requires `showIncrementalResults`. |\n| Incremental Purchases % | number | 0.05 | Incremental purchases as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Purchases Modeled | number | 123 | Modeled incremental purchases. Requires `showIncrementalResults`. |\n| Incremental Purchases Modeled % | number | 0.05 | Modeled incremental purchases as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases Campaign Incremental % | number | 0.05 | Campaign-level purchases incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Purchases Channel Incremental % | number | 0.05 | Channel-level purchases incrementality. Requires `showIncrementalResults`. |\n| Incremental Visits | number | 123 | Incremental visits vs holdout. Requires `showIncrementalResults`. |\n| Incremental Visits % | number | 0.05 | Incremental visits as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental Visits Modeled | number | 123 | Modeled incremental visits. Requires `showIncrementalResults`. |\n| Incremental Visits Modeled % | number | 0.05 | Modeled incremental visits as a share of impressions. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits Campaign Incremental % | number | 0.05 | Campaign-level visits incrementality. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Visits Channel Incremental % | number | 0.05 | Channel-level visits incrementality. Requires `showIncrementalResults`. |\n| Incremental Revenue | number | 123 | Incremental revenue vs holdout. Requires `showIncrementalResults`. |\n| Incremental Revenue Modeled | number | 123 | Modeled incremental revenue. Requires `showIncrementalResults`. |\n| Downloads Incremental | number | 123 | Incremental downloads. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Incremental Modeled | number | 123 | Modeled incremental downloads. Smart promo reports only. Requires `showIncrementalResults`. |\n| Downloads Campaign Incremental % | number | 0.05 | Campaign-level downloads incrementality. Smart promo reports only. Requires `showIncrementalResults` and campaign-level `incrementalDisplayType`. |\n| Downloads Channel Incremental % | number | 0.05 | Channel-level downloads incrementality. Smart promo reports only. Requires `showIncrementalResults`. |\n| Campaign Start Date | string | 2015-03-19 | Campaign start date in the format YYYY-mm-DD |\n| Campaign End Date | string | 2015-03-19 | Campaign end date in the format YYYY-mm-DD |\n| Campaign Expected Date| string | 2015-03-19 | Campaign expected date in the format YYYY-mm-DD |\n| Adswizz Campaign ID | string | 12345 | Adswizz campaign ID from pixel params (Adswizz platforms: adswizz, streaming_adswizz, adswizz_ron, streaming_adswizz_simple). Only populated when the column is requested and impressions were served via Adswizz. |\n| Month | string | 2023-12-01 | First day of the month in YYYY-mm-DD. Present when `timeGrouping` is `month`. |\n| eCPM | number | 12.5 | Estimated cost per thousand impressions. Excluded by default; request via `fields`. |\n| CPM | number | 10 | Cost per thousand impressions. Excluded by default; request via `fields`. |\n| Genre | string | Comedy | Genre of the show. Excluded by default; request via `fields`. |\n| Episode Duration | number | 3600 | Episode duration in seconds. Excluded by default; request via `fields`. |\n| Ad Servers | string | megaphone | Ad servers that served the impressions. Excluded by default; request via `fields`. |\n| Publish Date | string | 2023-12-18 | Date when the media content was published, in the format YYYY-mm-DD. |\n| Frequency | number | 1.5 | Average impressions per unique listener. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors % | number | 0.05 | Visitors as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits % | number | 0.04 | Visits as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads % | number | 0.01 | Leads as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs % | number | 0.01 | Installs as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups % | number | 0.02 | Signups as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases % | number | 0.02 | Purchases as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visitors Modeled % | number | 0.05 | Modeled visitors as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Visits Modeled % | number | 0.04 | Modeled visits as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Leads Modeled % | number | 0.01 | Modeled leads as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Installs Modeled % | number | 0.01 | Modeled installs as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Signups Modeled % | number | 0.02 | Modeled signups as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Purchases Modeled % | number | 0.02 | Modeled purchases as a share of impressions. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| ROAS | number | 2.5 | Return on advertising spend. Available when `timeGrouping` is `all`. |\n| ROAS Modeled | number | 2.5 | Modeled return on advertising spend. Available when `timeGrouping` is `all`. |\n| AOV | number | 45 | Average order value. Available when `timeGrouping` is `all`. |\n| AOV Modeled | number | 45 | Modeled average order value. Available when `timeGrouping` is `all`. |\n| Cost Per Visitor | number | 12 | Spend divided by visitors. Available when `timeGrouping` is `all`. |\n| Cost Per Visitor Modeled | number | 12 | Spend divided by modeled visitors. Available when `timeGrouping` is `all`. |\n| Cost Per Lead | number | 20 | Spend divided by leads. Available when `timeGrouping` is `all`. |\n| Cost Per Lead Modeled | number | 20 | Spend divided by modeled leads. Available when `timeGrouping` is `all`. |\n| Cost Per Install | number | 25 | Spend divided by installs. Available when `timeGrouping` is `all`. |\n| Cost Per Install Modeled | number | 25 | Spend divided by modeled installs. Available when `timeGrouping` is `all`. |\n| Cost Per Signup | number | 18 | Spend divided by signups. Available when `timeGrouping` is `all`. |\n| Cost Per Signup Modeled | number | 18 | Spend divided by modeled signups. Available when `timeGrouping` is `all`. |\n| Cost Per Purchase | number | 30 | Spend divided by purchases. Available when `timeGrouping` is `all`. |\n| Cost Per Purchase Modeled | number | 30 | Spend divided by modeled purchases. Available when `timeGrouping` is `all`. |\n| Cost Per Incremental Visitor | number | 12 | Spend divided by incremental visitors. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Visitor Modeled | number | 12 | Spend divided by modeled incremental visitors. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Lead | number | 20 | Spend divided by incremental leads. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Lead Modeled | number | 20 | Spend divided by modeled incremental leads. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Install | number | 25 | Spend divided by incremental installs. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Install Modeled | number | 25 | Spend divided by modeled incremental installs. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Signup | number | 18 | Spend divided by incremental signups. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Signup Modeled | number | 18 | Spend divided by modeled incremental signups. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Purchase | number | 30 | Spend divided by incremental purchases. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Cost Per Incremental Purchase Modeled | number | 30 | Spend divided by modeled incremental purchases. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental ROAS | number | 2.5 | Incremental return on advertising spend. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Incremental ROAS Modeled | number | 2.5 | Modeled incremental return on advertising spend. Requires `showIncrementalResults`. Available when `timeGrouping` is `all`. Excluded by default; request via `fields`. |\n| Itunes ID | string | 123 | iTunes ID of the show. Hidden by default; request via `fields`. |\n| YouTube Channel / Playlist ID | string | UCxxxx | YouTube channel or playlist ID of the show. Hidden by default; request via `fields`. |\n| Episode GUID | string | episode-guid | Guid of the episode. |\n| Campaign & Initiative | string | Campaign / Initiative | Combined campaign and initiative label. |\n| Campaign Unit | string | Mid | Booked campaign unit. Excluded by default; request via `fields`. |\n| Campaign Spend | number | 5000 | Booked cost of the campaign flight, or Podscribe's estimate when no rate is set. Blank for flights priced by CPM. Unlike Spend, this is planned rather than delivered. Excluded by default; request via `fields`. |\n| Expected Impressions | number | 250000 | Number of impressions the campaign flight was booked to deliver, as opposed to the delivered impression columns. Excluded by default; request via `fields`. |\n| Campaign Creatives | string | Creative A | Campaign creative names. Excluded by default; request via `fields`. |\n| Advertiser Industry | string | Retail | Advertiser industry. Excluded by default; request via `fields`. |\n| Offline Purchases | number | 12 | Offline purchase conversions. Excluded by default; request via `fields`. |\n| Online Purchases | number | 80 | Online purchase conversions. Excluded by default; request via `fields`. |\n| Offline Purchases Modeled | number | 12 | Modeled offline purchase conversions. Excluded by default; request via `fields`. |\n| Online Purchases Modeled | number | 80 | Modeled online purchase conversions. Excluded by default; request via `fields`. |\n| Offline Revenue | number | 400 | Offline revenue. Excluded by default; request via `fields`. |\n| Online Revenue | number | 3200 | Online revenue. Excluded by default; request via `fields`. |\n| Offline Revenue Modeled | number | 400 | Modeled offline revenue. Excluded by default; request via `fields`. |\n| Online Revenue Modeled | number | 3200 | Modeled online revenue. Excluded by default; request via `fields`. |\n| Bill To | string | Agency | Billing account. Excluded by default; request via `fields`. |\n| Campaign Delivery Issues | string | WRONG GEO | Campaign delivery issue flags. Excluded by default; request via `fields`. Not available for limited-overview API keys. |\n| Campaign Placement Issues | string | STALE READ | Campaign placement issue flags. Excluded by default; request via `fields`. Not available for limited-overview API keys. |\n| YouTube Engaged Views | number | 123 | Engaged YouTube views when Engaged Views is enabled. Hidden by default; request via `fields`. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "reports", "by-campaign", "device" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Advertiser\",\n \"Device\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"2013-08-30\",\n \"endDate\": \"1951-10-26\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cf3d487d-2877-4166-b7ac-b914b2719dbe", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "reports", "by-campaign", "device" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Advertiser\",\n \"Device\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"1961-07-12\",\n \"endDate\": \"2014-01-25\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c6075c1-4f9f-43b8-b270-20b6d75a6657", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "reports", "by-campaign", "device" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Advertiser\",\n \"Device\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"1961-07-12\",\n \"endDate\": \"2014-01-25\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62a37121-0367-4486-a98e-5d4322cbfce3", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "reports", "by-campaign", "device" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n \"Advertiser\",\n \"Device\",\n \"Media Type\",\n \"Type\",\n \"Tags\",\n \"Spend\",\n \"Publisher\",\n \"Campaign\",\n \"Show\",\n \"Episode\",\n \"Publish Date\",\n \"Podcast & Streaming Impressions\",\n \"YouTube Views\",\n \"Reach\",\n \"Visitors\",\n \"Visits\",\n \"Leads\",\n \"Installs\",\n \"Signups\",\n \"Purchases\",\n \"Revenue\",\n \"Visitors Modeled\",\n \"Visits Modeled\",\n \"Leads Modeled\",\n \"Installs Modeled\",\n \"Signups Modeled\",\n \"Purchases Modeled\",\n \"Revenue Modeled\",\n \"Clicks\",\n \"Campaign ID\",\n \"Campaign Internal ID\",\n \"Publisher ID\",\n \"Product\",\n \"Initiative\",\n \"Business Line\",\n \"Rumble Impressions\",\n \"Spotify Video Impressions\",\n \"Episode GUID\",\n \"Campaign & Initiative\",\n \"Campaign Promo\",\n \"ROAS\",\n \"ROAS Modeled\",\n \"AOV\",\n \"AOV Modeled\",\n \"Cost Per Visitor\",\n \"Cost Per Visitor Modeled\",\n \"Cost Per Lead\",\n \"Cost Per Lead Modeled\",\n \"Cost Per Install\",\n \"Cost Per Install Modeled\",\n \"Cost Per Signup\",\n \"Cost Per Signup Modeled\",\n \"Cost Per Purchase\",\n \"Cost Per Purchase Modeled\",\n \"Campaign Start Date\",\n \"Campaign Expected Date\",\n \"Campaign End Date\",\n \"Week\",\n \"Day\",\n \"Month\"\n ],\n \"fieldMapping\": {\n \"Day\": \"timestamp\",\n \"Publish Date\": \"episode_upload\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"1961-07-12\",\n \"endDate\": \"2014-01-25\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": true,\n \"svSimulcastConv\": true,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"timeGrouping\": \"day\",\n \"useNonPurchasesRevenue\": false,\n \"weekStartsOn\": \"monday\",\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c9d12be-9ea2-4c16-8917-bd7dab173c96", "name": "Lag", "request": { "name": "Lag", "description": { "content": "Attributed actions per day after the impression, for each action and `groupKey` value.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|---------------------------------|----------|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|\n| Action | string | purchase | Target action, such as purchase/visitor/signup |\n| Object ID | string | podcast | ID of the object as resulted by applying the provided groupKey |\n| Day 1...N | number | 3.5 | How many of the total actions had a lag in the N-th 24-hour period after the impression (Day 1 = 0-24 h, Day 2 = 24-48 h). A window of W days has W + 1 day columns. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "reports", "lag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"advertiser\": [\n \"string\",\n \"string\"\n ],\n \"groupKey\": \"campaigns\",\n \"name\": \"string\",\n \"actions\": [\n \"string\",\n \"string\"\n ],\n \"startDate\": \"1980-07-17\",\n \"endDate\": \"1990-10-30\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": false,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"useNonPurchasesRevenue\": false,\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "84acb5c9-dcbb-4c45-84ac-c7e7d13c9032", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "reports", "lag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": [\n \"string\",\n \"string\"\n ],\n \"groupKey\": \"publisher\",\n \"name\": \"string\",\n \"actions\": [\n \"string\",\n \"string\"\n ],\n \"startDate\": \"1999-02-01\",\n \"endDate\": \"1997-09-13\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": false,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"useNonPurchasesRevenue\": false,\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec83c880-4f08-4ef2-9177-32352062ce48", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "reports", "lag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": [\n \"string\",\n \"string\"\n ],\n \"groupKey\": \"publisher\",\n \"name\": \"string\",\n \"actions\": [\n \"string\",\n \"string\"\n ],\n \"startDate\": \"1999-02-01\",\n \"endDate\": \"1997-09-13\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": false,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"useNonPurchasesRevenue\": false,\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bad380e0-2e2b-43ec-a733-3ecc4fe682e6", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "reports", "lag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": [\n \"string\",\n \"string\"\n ],\n \"groupKey\": \"publisher\",\n \"name\": \"string\",\n \"actions\": [\n \"string\",\n \"string\"\n ],\n \"startDate\": \"1999-02-01\",\n \"endDate\": \"1997-09-13\",\n \"ytSimulcastConv\": true,\n \"rSimulcastConv\": false,\n \"svSimulcastConv\": true,\n \"includeYtSpend\": false,\n \"spendOnPublishDate\": true,\n \"useSettingsProfiles\": false,\n \"attributionWindow\": 30,\n \"attributionStreamingWindow\": 14,\n \"attributionSaiWindow\": 30,\n \"attributionModel\": \"multi_timedecay\",\n \"attributionPreset\": \"any\",\n \"excludeReferrers\": [\n \"email\",\n \"facebook\",\n \"tiktok\",\n \"instagram\",\n \"twitter\"\n ],\n \"excludeUtmMediums\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"sms\",\n \"social\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludeUtmSources\": [\n \"email\",\n \"facebook\",\n \"fb\",\n \"tiktok\",\n \"twitter\",\n \"klaviyo\",\n \"youtube\",\n \"instagram\",\n \"ig\"\n ],\n \"excludePriorCustomers\": false,\n \"excludePriorVisitors\": false,\n \"showIncrementalResults\": false,\n \"incrementalDisplayType\": \"smart_serve_or_channel\",\n \"timeRangeConv\": false,\n \"timeRangeConvWithWindow\": false,\n \"useNonPurchasesRevenue\": false,\n \"campaignTags\": [\n \"string\",\n \"string\"\n ],\n \"campaignTagsExclude\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b014618-3926-414b-9e67-9677d87269bd", "name": "Radio", "request": { "name": "Radio", "description": { "content": "Radio ad spots, impressions, spend and conversions, grouped by the requested dimensions and period.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult CSV columns follow the request: the `timeGrouping` column first, then `fieldGrouping` dimensions in order, then metric columns in `fields` order.\n\nResult file format:\n| Field | Type | Example | Description |\n|---------------------|--------|--------------------|-------------------------------------------------------------------------|\n| Day, Week, or Month | string | 2025-04-01 | Column header is `Day`, `Week`, or `Month` depending on `timeGrouping`. |\n| DMA | string | New York NY | Designated Market Area. |\n| Genre | string | News | Radio genre. |\n| Owner | string | Some owner | Station or inventory owner. |\n| Radio Station | string | Some radio station | Radio station name. |\n| Channel | string | CNBC | Satellite Radio Channel (SXM only). |\n| Ad ID | string | ad_7f3a2b | Ad identifier. |\n| ISCI Code | string | ABCD1234 | Industry Standard Commercial Identifier. |\n| Day Part | string | MIDDAY | Daypart of the spot. |\n| Publisher | string | Some publisher | Name of the publisher. |\n| Campaign | string | My Campaign | Name of the advertising campaign. |\n| Impressions | number | 123 | Number of impressions. |\n| No. of Ads | number | 123 | Number of ad spots. |\n| Spend | number | 123 | Amount spent. |\n| Visits | number | 123 | Number of visits. |\n| Visitors | number | 123 | Number of visitors. |\n| Installs | number | 123 | Number of app installs. |\n| Signups | number | 123 | Number of signups. |\n| Leads | number | 123 | Number of leads. |\n| Purchases | number | 123 | Number of purchases. |\n| Revenue | number | 123 | Revenue generated. |\n| Cost per Ad | number | 123 | Cost per ad spot. |\n| Cost per Visit | number | 123 | Cost per visit. |\n| Cost per Visitor | number | 123 | Cost per visitor. |\n| Cost per Install | number | 123 | Cost per install. |\n| Cost per Signup | number | 123 | Cost per signup. |\n| Cost per Lead | number | 123 | Cost per lead. |\n| Cost per Purchase | number | 123 | Cost per purchase. |\n| CPM | number | 123 | Cost per thousand impressions. |\n| CPA | number | 123 | Cost per acquisition. |\n| ROAS | number | 123 | Return on advertising spend. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "radio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\"\n ],\n \"fieldGrouping\": [\n \"DMA\"\n ],\n \"fields\": [\n \"Impressions\",\n \"No. of Ads\",\n \"Spend\",\n \"Visits\",\n \"Visitors\",\n \"Installs\",\n \"Signups\",\n \"Leads\",\n \"Purchases\",\n \"Revenue\",\n \"Cost per Ad\",\n \"Cost per Visit\",\n \"Cost per Visitor\",\n \"Cost per Install\",\n \"Cost per Signup\",\n \"Cost per Lead\",\n \"Cost per Purchase\",\n \"CPM\",\n \"CPA\",\n \"ROAS\"\n ],\n \"fieldMapping\": {\n \"Impressions\": \"delivery_imps\",\n \"DMA\": \"market\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"1970-07-26\",\n \"endDate\": \"2015-08-04\",\n \"timeGrouping\": \"day\",\n \"weekStartsOn\": \"sunday\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ef4b2c23-7cef-464d-80f7-a7bccded8843", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "radio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\"\n ],\n \"fieldGrouping\": [\n \"Publisher\"\n ],\n \"fields\": [\n \"Impressions\",\n \"No. of Ads\",\n \"Spend\",\n \"Visits\",\n \"Visitors\",\n \"Installs\",\n \"Signups\",\n \"Leads\",\n \"Purchases\",\n \"Revenue\",\n \"Cost per Ad\",\n \"Cost per Visit\",\n \"Cost per Visitor\",\n \"Cost per Install\",\n \"Cost per Signup\",\n \"Cost per Lead\",\n \"Cost per Purchase\",\n \"CPM\",\n \"CPA\",\n \"ROAS\"\n ],\n \"fieldMapping\": {\n \"Impressions\": \"delivery_imps\",\n \"DMA\": \"market\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"1971-09-08\",\n \"endDate\": \"1995-12-10\",\n \"timeGrouping\": \"day\",\n \"weekStartsOn\": \"sunday\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd4af11a-47d4-409d-b489-152bd2889b4b", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "radio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\"\n ],\n \"fieldGrouping\": [\n \"Publisher\"\n ],\n \"fields\": [\n \"Impressions\",\n \"No. of Ads\",\n \"Spend\",\n \"Visits\",\n \"Visitors\",\n \"Installs\",\n \"Signups\",\n \"Leads\",\n \"Purchases\",\n \"Revenue\",\n \"Cost per Ad\",\n \"Cost per Visit\",\n \"Cost per Visitor\",\n \"Cost per Install\",\n \"Cost per Signup\",\n \"Cost per Lead\",\n \"Cost per Purchase\",\n \"CPM\",\n \"CPA\",\n \"ROAS\"\n ],\n \"fieldMapping\": {\n \"Impressions\": \"delivery_imps\",\n \"DMA\": \"market\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"1971-09-08\",\n \"endDate\": \"1995-12-10\",\n \"timeGrouping\": \"day\",\n \"weekStartsOn\": \"sunday\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a893533-c3d4-4a9c-ace0-b2f787475efa", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "radio" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\"\n ],\n \"fieldGrouping\": [\n \"Publisher\"\n ],\n \"fields\": [\n \"Impressions\",\n \"No. of Ads\",\n \"Spend\",\n \"Visits\",\n \"Visitors\",\n \"Installs\",\n \"Signups\",\n \"Leads\",\n \"Purchases\",\n \"Revenue\",\n \"Cost per Ad\",\n \"Cost per Visit\",\n \"Cost per Visitor\",\n \"Cost per Install\",\n \"Cost per Signup\",\n \"Cost per Lead\",\n \"Cost per Purchase\",\n \"CPM\",\n \"CPA\",\n \"ROAS\"\n ],\n \"fieldMapping\": {\n \"Impressions\": \"delivery_imps\",\n \"DMA\": \"market\"\n },\n \"formatting\": {\n \"numberFormatting\": true,\n \"summary\": true\n },\n \"name\": \"string\",\n \"startDate\": \"1971-09-08\",\n \"endDate\": \"1995-12-10\",\n \"timeGrouping\": \"day\",\n \"weekStartsOn\": \"sunday\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ab66558c-0181-44ac-83fe-beadff5106ac", "name": "Integration Health", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "fc95cc1b-cfaa-4bcb-9b0f-bf7b33196714", "name": "Get Integration Health", "request": { "name": "Get Integration Health", "description": { "content": "Retrieves the health status of various integrations, including issues and timestamps. Optionally filter by advertiser name and include pixel data.", "type": "text/plain" }, "url": { "path": [ "api", "public", "integration-health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2dc890fa-f6cb-4a75-bb72-a006561165cf", "originalRequest": { "url": { "path": [ "api", "public", "integration-health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"name\": \"string\",\n \"lookupName\": \"string\",\n \"issues\": [\n {\n \"type\": \"string\",\n \"reported_at\": \"1996-02-25T23:43:11.098Z\",\n \"actions\": [\n \"purchase\",\n \"signup\"\n ]\n },\n {\n \"type\": \"string\",\n \"reported_at\": \"1972-05-30T01:11:26.702Z\",\n \"actions\": [\n \"purchase\",\n \"signup\"\n ]\n }\n ],\n \"pixels\": [\n {\n \"action\": \"string\",\n \"last_url\": \"string\",\n \"last_seen\": \"string\"\n },\n {\n \"action\": \"string\",\n \"last_url\": \"string\",\n \"last_seen\": \"string\"\n }\n ]\n },\n {\n \"name\": \"string\",\n \"lookupName\": \"string\",\n \"issues\": [\n {\n \"type\": \"string\",\n \"reported_at\": \"1955-11-28T09:35:25.801Z\",\n \"actions\": [\n \"purchase\",\n \"signup\"\n ]\n },\n {\n \"type\": \"string\",\n \"reported_at\": \"1974-05-05T12:38:43.282Z\",\n \"actions\": [\n \"purchase\",\n \"signup\"\n ]\n }\n ],\n \"pixels\": [\n {\n \"action\": \"string\",\n \"last_url\": \"string\",\n \"last_seen\": \"string\"\n },\n {\n \"action\": \"string\",\n \"last_url\": \"string\",\n \"last_seen\": \"string\"\n }\n ]\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11d93011-5d59-472c-897a-cfd698bf27e7", "name": "Bad Request - Invalid request body", "originalRequest": { "url": { "path": [ "api", "public", "integration-health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c5a2ad2-54bf-4d4f-be36-a80d24127f4f", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "integration-health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b74c87b-5ca7-4309-a95e-321d886b0904", "name": "Request timed out. Only possible when `withPixels` is true, since pixel data is computed on request.", "originalRequest": { "url": { "path": [ "api", "public", "integration-health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f46b5bb9-55ae-4f8f-8aec-cd5f2b665b1b", "name": "Utils", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "152073e2-33aa-4556-b397-12802140111c", "name": "Get File Processing Status", "request": { "name": "Get File Processing Status", "description": { "content": "1. Retrieve the endpoint that uses the task system.\n2. Extract the `id` field from the response.\n3. Fetch this endpoint using the `id` field while the status is pending.\n4. Once the data processing is complete, this endpoint will return a `status` of 'done' along with the `url` field.\n5. Retrieve the link to access the data file.\n\nThis endpoint takes no API key. Every other endpoint requires one; see the Authentication guide\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "file-processor", "status", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f", "key": "id", "description": "(Required) Task ID from endpoint that returns task" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f4740575-38bc-40b7-a691-3158e463a97b", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "file-processor", "status", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f", "key": "id", "description": "(Required) Task ID from endpoint that returns task" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bd40375-1cc4-4bf9-8a26-16365a056963", "name": "Task not found.", "originalRequest": { "url": { "path": [ "api", "public", "file-processor", "status", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f", "key": "id", "description": "(Required) Task ID from endpoint that returns task" } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "05b29215-e9dc-46e5-9b70-0eda41506bdb", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "file-processor", "status", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f", "key": "id", "description": "(Required) Task ID from endpoint that returns task" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "bdafb2e5-abba-473f-b717-cca1ec48d595", "name": "Shows", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f346f7c9-622f-4ed4-bd54-4d685e781593", "name": "Show Info", "request": { "name": "Show Info", "description": { "content": "Episodes, advertisers, downloads and other details of a show.", "type": "text/plain" }, "url": { "path": [ "api", "public", "series", "episodes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "episodesPageIndex", "value": "3605", "description": "Zero-based page index. Ignored unless pagination is on (at least one of episodesPageIndex or episodesPageSize is sent). If you send only episodesPageSize, this value is 0." }, { "disabled": false, "key": "episodesPageSize", "value": "35", "description": "Episodes per page (max 100). Ignored unless pagination is on (at least one of episodesPageIndex or episodesPageSize is sent). If you send only episodesPageIndex, this value is 25." }, { "disabled": false, "key": "netNewReachAdvertisers", "value": "string", "description": "Comma-separated advertiser lookup names to compute net new reach for, for example `zocdoc`. Listeners already exposed to any of the listed advertisers are excluded from the net new reach, so several names behave as a single combined advertiser. Net new reach covers every campaign the advertiser runs, including campaigns booked through other agencies. Each name must be an advertiser the API key has access to, otherwise the request is rejected with 403. At most 10 names are accepted, and at least one is required when the parameter is present. Net new reach is only measured for podcasts, so other shows never carry the field. Without this parameter the response has no `netNewReachPercent` field." }, { "disabled": false, "key": "months", "value": "1", "description": "Size of the listening window used for net new reach, in months. Only applies together with netNewReachAdvertisers." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ITunes ID / YouTube Channel ID / YouTube Playlist ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "49e3ad8a-3d55-40a8-af8a-34cdccaf0408", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "series", "episodes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "episodesPageIndex", "value": "3605" }, { "key": "episodesPageSize", "value": "35" }, { "key": "netNewReachAdvertisers", "value": "string" }, { "key": "months", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ITunes ID / YouTube Channel ID / YouTube Playlist ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"podscribeSeriesId\": 6959.11121731257,\n \"title\": \"string\",\n \"platform\": \"Twitch\",\n \"monthlyListeners\": 3373.3447969382114,\n \"monthlyDownloads\": 1092.9522538365454,\n \"avgDownloadsPerEpisode\": 3332.4212738286765,\n \"ytAvgDownloadsPerEpisode\": 7483.460708634284,\n \"ytMonthlyDownloads\": 3978.9683529196163,\n \"spotifyAvgDownloadsPerEpisode\": 7417.606772506582,\n \"spotifyMonthlyDownloads\": 4359.214817725166,\n \"rumbleAvgDownloadsPerEpisode\": 4305.143477878477,\n \"rumbleMonthlyDownloads\": 3074.502983555469,\n \"podcastMonthlyDownloads\": 9757.365738256696,\n \"podcastAvgDownloadsPerEpisode\": 7348.079983430327,\n \"directRes\": 3477.874390496374,\n \"hostRead\": 1194.9773520232054,\n \"countAds\": 6652.129048181266,\n \"topAdvertisers\": [\n \"string\",\n \"string\"\n ],\n \"similarShows\": [\n {\n \"seriesId\": 5076.312772287041,\n \"title\": \"string\",\n \"contentSimilarity\": 8213.14321252784,\n \"audienceSimilarityTransunion\": 5785.491479509777,\n \"audienceSimilaritySocial\": 4859.2453900162045,\n \"audienceSimilarityOverlap\": 3763.3682023629644,\n \"audienceSimilarityOverlapReverse\": 3275.455188797851\n },\n {\n \"seriesId\": 5708.8001024572495,\n \"title\": \"string\",\n \"contentSimilarity\": 3957.2701876929827,\n \"audienceSimilarityTransunion\": 7957.344863962037,\n \"audienceSimilaritySocial\": 5812.809705826365,\n \"audienceSimilarityOverlap\": 3485.366153565346,\n \"audienceSimilarityOverlapReverse\": 4733.508184659659\n }\n ],\n \"renewalRate\": 1684.2572253603616,\n \"adLoad\": 9628.856722500554,\n \"adLoadYT\": 7018.534928036546,\n \"isPodscribePrefixPlaced\": false,\n \"spotifyVideoOptInDate\": \"1995-01-31T22:38:12.230Z\",\n \"twitter\": \"string\",\n \"facebook\": \"string\",\n \"instagram\": \"string\",\n \"youtube\": \"string\",\n \"tiktok\": \"string\",\n \"numTwitterFans\": 8338.637320592272,\n \"numFbFans\": 6261.736806957403,\n \"numIgFans\": 449.690394736797,\n \"numYoutubeFans\": 8794.207686766527,\n \"numTiktokFans\": 5785.2129840241305,\n \"contentRisk\": {\n \"seriesId\": 5598.633716530903,\n \"overallScore\": \"floor\",\n \"scoreByCategory\": {\n \"key_0\": \"string\"\n }\n },\n \"episodes\": [\n {\n \"title\": \"string\",\n \"podscribeEpisodeId\": 5239.841513348213,\n \"description\": \"string\",\n \"downloads\": 1931.4598121497183,\n \"downloadsAt30Days\": 7376.558791079697,\n \"downloadsAt7Days\": 328.2905865713026,\n \"podcastDownloads\": 4774.730468830541,\n \"podcastDownloadsAt30Days\": 3406.5981487854224,\n \"podcastDownloadsAt7Days\": 5781.083528340901,\n \"youtubeDownloads\": 5597.932464077519,\n \"youtubeDownloadsAt30Days\": 9833.726128219305,\n \"youtubeDownloadsAt7Days\": 9221.975100016618,\n \"spotifyDownloads\": 8647.84991404457,\n \"spotifyDownloadsAt30Days\": 7958.956618643616,\n \"spotifyDownloadsAt7Days\": 2641.468767550075,\n \"rumbleDownloads\": 9638.038270154726,\n \"rumbleDownloadsAt30Days\": 9440.298444859778,\n \"rumbleDownloadsAt7Days\": 7862.956826671565,\n \"duration\": 999.0840881616392,\n \"uploadedAt\": \"1992-03-31T01:23:13.955Z\",\n \"url\": \"string\",\n \"guid\": \"string\",\n \"adLoad\": 6188.434985629887,\n \"ads\": [\n {\n \"adId\": 5433.035519210629,\n \"advertiser\": \"string\",\n \"startTs\": 7535.3198546078675,\n \"endTs\": 1017.3564093299947,\n \"placementGroupNum\": 438,\n \"placementNum\": 1936,\n \"placementNumInGroup\": 5386,\n \"placementUnit\": \"string\"\n },\n {\n \"adId\": 5039.424645815887,\n \"advertiser\": \"string\",\n \"startTs\": 951.4948681111024,\n \"endTs\": 367.3005311867916,\n \"placementGroupNum\": 8790,\n \"placementNum\": 5449,\n \"placementNumInGroup\": 6267,\n \"placementUnit\": \"string\"\n }\n ],\n \"userAgents\": [\n {\n \"key_0\": 5844.562015020527\n },\n {\n \"key_0\": 3796.3064644207334\n }\n ]\n },\n {\n \"title\": \"string\",\n \"podscribeEpisodeId\": 6148.452188626748,\n \"description\": \"string\",\n \"downloads\": 7530.702324719776,\n \"downloadsAt30Days\": 9514.897995720385,\n \"downloadsAt7Days\": 2194.4482018212884,\n \"podcastDownloads\": 4145.826006429989,\n \"podcastDownloadsAt30Days\": 5959.556540850242,\n \"podcastDownloadsAt7Days\": 704.6953046948579,\n \"youtubeDownloads\": 3653.3048844932446,\n \"youtubeDownloadsAt30Days\": 3465.1689158540444,\n \"youtubeDownloadsAt7Days\": 9317.551565003852,\n \"spotifyDownloads\": 6820.477105823635,\n \"spotifyDownloadsAt30Days\": 389.4963121645634,\n \"spotifyDownloadsAt7Days\": 317.023229501765,\n \"rumbleDownloads\": 355.5688232581455,\n \"rumbleDownloadsAt30Days\": 7049.978178902416,\n \"rumbleDownloadsAt7Days\": 1144.4011124275755,\n \"duration\": 3148.1876049856437,\n \"uploadedAt\": \"1978-04-05T07:28:04.189Z\",\n \"url\": \"string\",\n \"guid\": \"string\",\n \"adLoad\": 658.4697088545744,\n \"ads\": [\n {\n \"adId\": 9691.2482716959,\n \"advertiser\": \"string\",\n \"startTs\": 6242.303239772915,\n \"endTs\": 7872.846311143287,\n \"placementGroupNum\": 3854,\n \"placementNum\": 2562,\n \"placementNumInGroup\": 4215,\n \"placementUnit\": \"string\"\n },\n {\n \"adId\": 4139.9539929764105,\n \"advertiser\": \"string\",\n \"startTs\": 5275.0198608509,\n \"endTs\": 8400.200142366682,\n \"placementGroupNum\": 8422,\n \"placementNum\": 576,\n \"placementNumInGroup\": 4744,\n \"placementUnit\": \"string\"\n }\n ],\n \"userAgents\": [\n {\n \"key_0\": 8552.569089750643\n },\n {\n \"key_0\": 4091.4850788358326\n }\n ]\n }\n ],\n \"episodesPagination\": {\n \"pageIndex\": 7092,\n \"pageSize\": 1592,\n \"rowCount\": 1159\n },\n \"netNewReachPercent\": 2643.367011495932\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b99c103-50de-4b18-be11-25626c2a4a96", "name": "Invalid query parameters (for example, episodesPageIndex is not a non-negative integer, episodesPageSize is not an integer between 1 and 100, netNewReachAdvertisers is empty or lists more than 10 advertisers, or netNewReachAdvertisers is used with a months value that is not an integer between 1 and 3).", "originalRequest": { "url": { "path": [ "api", "public", "series", "episodes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "episodesPageIndex", "value": "3605" }, { "key": "episodesPageSize", "value": "35" }, { "key": "netNewReachAdvertisers", "value": "string" }, { "key": "months", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ITunes ID / YouTube Channel ID / YouTube Playlist ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\",\n \"statusCode\": 3964.1183435401263\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ea4cbc9-5d11-4e3c-869a-136e8a8c8c98", "name": "The API key does not have access to one of the advertisers passed in netNewReachAdvertisers.", "originalRequest": { "url": { "path": [ "api", "public", "series", "episodes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "episodesPageIndex", "value": "3605" }, { "key": "episodesPageSize", "value": "35" }, { "key": "netNewReachAdvertisers", "value": "string" }, { "key": "months", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ITunes ID / YouTube Channel ID / YouTube Playlist ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8a2582b-e6dd-40c4-96bf-23d864e6c349", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "api", "public", "series", "episodes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "episodesPageIndex", "value": "3605" }, { "key": "episodesPageSize", "value": "35" }, { "key": "netNewReachAdvertisers", "value": "string" }, { "key": "months", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ITunes ID / YouTube Channel ID / YouTube Playlist ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "587a54cc-5101-4fef-ad8f-a34eea334cfe", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "series", "episodes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "episodesPageIndex", "value": "3605" }, { "key": "episodesPageSize", "value": "35" }, { "key": "netNewReachAdvertisers", "value": "string" }, { "key": "months", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ITunes ID / YouTube Channel ID / YouTube Playlist ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2879af34-81bb-4a1f-9ad5-668b98b862af", "name": "Request timed out.", "originalRequest": { "url": { "path": [ "api", "public", "series", "episodes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "episodesPageIndex", "value": "3605" }, { "key": "episodesPageSize", "value": "35" }, { "key": "netNewReachAdvertisers", "value": "string" }, { "key": "months", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) ITunes ID / YouTube Channel ID / YouTube Playlist ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Gateway Timeout", "code": 504, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d5a6414-4041-4a67-9634-144da2ae7ff1", "name": "TransUnion Audience", "request": { "name": "TransUnion Audience", "description": { "content": "Audience share and podcast population index per TransUnion attribute value, for one show.\n\nAudience data from social channels is available through the API as well. Please contact Partnerships for enablement.\n\nRequires a Pro account. At least one of `podscribe_id` or `itunes_id` must be\nsupplied; passing neither returns HTTP 400. If both are provided, `podscribe_id`\ntakes priority.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|--------------------------|--------|----------------|-----------------------------------------------------------|\n| Show | string | The Daily | Name of the show. |\n| Category | string | Demographics | Top-level TransUnion segment category. |\n| Subcategory | string | Age | Nested TransUnion segment grouping within the category. |\n| Attribute | string | Age 25-34 | TransUnion audience attribute name. |\n| Value | string | 25-34 | Segment value or bucket label for the attribute. |\n| Percent | string | 12.4% | Share of the show's audience for the segment value, as a percentage. |\n| Podcast Population Index | number | 134 | Index compared with the podcast population baseline. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "podscribe_id", "value": "2725.876346435465", "description": "Podscribe Show ID. Takes priority over itunes_id when both are provided." }, { "disabled": false, "key": "itunes_id", "value": "2725.876346435465", "description": "iTunes ID. Used when podscribe_id is not provided." }, { "disabled": false, "key": "name", "value": "string", "description": "Optional display name for the generated report. Shown in the Reports UI. Ignored when an identical cached report is reused; pass a new request (or wait for cache expiry) to apply a new name.\n" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b46a74ba-a30d-402a-8915-c695227ec1c9", "name": "Task created successfully", "originalRequest": { "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "podscribe_id", "value": "2725.876346435465" }, { "key": "itunes_id", "value": "2725.876346435465" }, { "key": "name", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"c8acd731-fe58-60e6-255f-9624a26f9d44\",\n \"status\": \"pending\",\n \"url\": \"https://GA.ikeKIStoqQxEIDHNcZ2I3vTtnAjkVkFNHzH7+wut-uj+gGJxNVjZ0FdgsuO7HD-jl\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cc65415-869f-46a5-88e8-9732ffc57a9e", "name": "Bad request — neither podscribe_id nor itunes_id provided", "originalRequest": { "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "podscribe_id", "value": "2725.876346435465" }, { "key": "itunes_id", "value": "2725.876346435465" }, { "key": "name", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00a8e3f7-fe6a-4237-835b-c566a61d5ba5", "name": "Forbidden — user does not have Pro access", "originalRequest": { "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "podscribe_id", "value": "2725.876346435465" }, { "key": "itunes_id", "value": "2725.876346435465" }, { "key": "name", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b7b37f29-a45f-4be9-adfa-9a0cac2056f3", "name": "Show not found", "originalRequest": { "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "podscribe_id", "value": "2725.876346435465" }, { "key": "itunes_id", "value": "2725.876346435465" }, { "key": "name", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d8f38a2-d372-458e-99ac-8fad410aa3d6", "name": "Unexpected error", "originalRequest": { "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "podscribe_id", "value": "2725.876346435465" }, { "key": "itunes_id", "value": "2725.876346435465" }, { "key": "name", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c7ffd68f-d686-42ed-a6e6-94969ffaf7d2", "name": "TransUnion (Multi-Show)", "request": { "name": "TransUnion (Multi-Show)", "description": { "content": "Audience share and podcast population index per TransUnion attribute value, for each requested show.\n\nAudience data from social channels is available through the API as well. Please contact Partnerships for enablement.\n\nRequires a Pro account. At least one of `podscribe_ids` or `itunes_ids` must be supplied.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|--------------------------|--------|----------------|-----------------------------------------------------------|\n| Show | string | The Daily | Name of the show. |\n| Category | string | Demographics | Top-level TransUnion segment category. |\n| Subcategory | string | Age | Nested TransUnion segment grouping within the category. |\n| Attribute | string | Age 25-34 | TransUnion audience attribute name. |\n| Value | string | 25-34 | Segment value or bucket label for the attribute. |\n| Percent | string | 12.4% | Share of the show's audience for the segment value, as a percentage. |\n| Podcast Population Index | number | 134 | Index compared with the podcast population baseline. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"podscribe_ids\": [\n 4333.88297382568,\n 2179.8837061671074\n ],\n \"itunes_ids\": [\n 5362.716888839061,\n 2477.0081537807264\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c9a93f30-1500-451a-b16a-12a55aa4e472", "name": "Task created successfully", "originalRequest": { "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"podscribe_ids\": [\n 3038.862490303309,\n 2824.1369081272082\n ],\n \"itunes_ids\": [\n 7117.716938613601,\n 2074.606649821216\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"c8acd731-fe58-60e6-255f-9624a26f9d44\",\n \"status\": \"pending\",\n \"url\": \"https://GA.ikeKIStoqQxEIDHNcZ2I3vTtnAjkVkFNHzH7+wut-uj+gGJxNVjZ0FdgsuO7HD-jl\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27b80f3e-db3c-444a-a6d4-3aa672dbb77c", "name": "Bad request — neither podscribe_ids nor itunes_ids provided", "originalRequest": { "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"podscribe_ids\": [\n 3038.862490303309,\n 2824.1369081272082\n ],\n \"itunes_ids\": [\n 7117.716938613601,\n 2074.606649821216\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3cdb3e7b-463b-4d61-8e61-dfa27c6afc60", "name": "Forbidden — user does not have Pro access", "originalRequest": { "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"podscribe_ids\": [\n 3038.862490303309,\n 2824.1369081272082\n ],\n \"itunes_ids\": [\n 7117.716938613601,\n 2074.606649821216\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4d4e46c1-2b1d-46e2-9d54-0bba9e89b18c", "name": "Show not found", "originalRequest": { "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"podscribe_ids\": [\n 3038.862490303309,\n 2824.1369081272082\n ],\n \"itunes_ids\": [\n 7117.716938613601,\n 2074.606649821216\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a31ca90c-4ca6-4fe4-9363-923c1aec9939", "name": "Unexpected error", "originalRequest": { "url": { "path": [ "api", "public", "series", "transunion" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"podscribe_ids\": [\n 3038.862490303309,\n 2824.1369081272082\n ],\n \"itunes_ids\": [\n 7117.716938613601,\n 2074.606649821216\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6a1f277-3d51-42a7-810a-9e6fc2da7e25", "name": "Listener IDs (Episode)", "request": { "name": "Listener IDs (Episode)", "description": { "content": "**Note:** Pass advertiser to get that advertiser's impressions, plus prefix listeners when the advertiser has an ad in the episode.\n\nAnonymized listener IDs for an episode, each with its number of listens.\n\n\n > This endpoint utilizes a task system.\n >\n > Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n > to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|---------|--------|--------------|--------------------------------------------------|\n| User Id | string | abcd1234efgh | An anonymized listener identifier. |\n| Frequency | number | 3 | Number of qualifying listens for that listener. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "episode", "impression-listeners", ":podscribe_episode_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "week_lb", "value": "8", "description": "The number of weeks back to get data for" }, { "disabled": false, "key": "advertiser", "value": "string", "description": "Single advertiser lookup name the caller can access. Omit to include prefix listeners only." } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_episode_id", "description": "(Required) The Podscribe episode ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f6125ae3-2a3e-49c3-8041-5909a77de5f7", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "episode", "impression-listeners", ":podscribe_episode_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "week_lb", "value": "8" }, { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_episode_id", "description": "(Required) The Podscribe episode ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a04cd85e-aa28-43ff-bea5-3fb995a94bb8", "name": "advertiser is not a single string, more than one advertiser was provided, or the caller cannot access the advertiser", "originalRequest": { "url": { "path": [ "api", "public", "episode", "impression-listeners", ":podscribe_episode_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "week_lb", "value": "8" }, { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_episode_id", "description": "(Required) The Podscribe episode ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "caa8f279-922a-4856-829a-e5c8d201e454", "name": "Invalid token, no API access, or only campaign reporting access", "originalRequest": { "url": { "path": [ "api", "public", "episode", "impression-listeners", ":podscribe_episode_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "week_lb", "value": "8" }, { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_episode_id", "description": "(Required) The Podscribe episode ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83f85389-473d-45d6-85a2-ac22683a6ef6", "name": "No active or recently ended campaign on the show", "originalRequest": { "url": { "path": [ "api", "public", "episode", "impression-listeners", ":podscribe_episode_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "week_lb", "value": "8" }, { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_episode_id", "description": "(Required) The Podscribe episode ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a0d59e0-cb30-435e-b79f-3ece474fdd9d", "name": "Monthly request limit exceeded", "originalRequest": { "url": { "path": [ "api", "public", "episode", "impression-listeners", ":podscribe_episode_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "week_lb", "value": "8" }, { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_episode_id", "description": "(Required) The Podscribe episode ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3576bb0d-63e2-45fc-9187-c23008ce809a", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "episode", "impression-listeners", ":podscribe_episode_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "week_lb", "value": "8" }, { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_episode_id", "description": "(Required) The Podscribe episode ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0267771-1b12-43e2-832c-caacfd86a55f", "name": "Listener IDs (Show)", "request": { "name": "Listener IDs (Show)", "description": { "content": "**Note:** only prefix impressions are included.\n\nAnonymized listener IDs for a show's episodes, each with its number of listens in the last 90 days.\n\n\n > This endpoint utilizes a task system.\n >\n > Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n > to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|----------|--------|--------------|--------------------------------------------------|\n| User Id | string | abcd1234efgh | An anonymized listener identifier. |\n| Frequency| number | 5 | Number of qualifying listens for that listener. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "series", "impression-listeners", ":podscribe_show_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "advertiser", "value": "string", "description": "The advertiser to get data for" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_show_id", "description": "(Required) The Podscribe show ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1f8c2ee4-6538-473c-9e48-b138f3560dbe", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "series", "impression-listeners", ":podscribe_show_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_show_id", "description": "(Required) The Podscribe show ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b7b1165-9e36-49d9-9581-b9ad23ab5302", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "api", "public", "series", "impression-listeners", ":podscribe_show_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_show_id", "description": "(Required) The Podscribe show ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "755fcf83-3c30-4b19-92cf-5ac5d7475d3f", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "series", "impression-listeners", ":podscribe_show_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_show_id", "description": "(Required) The Podscribe show ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41d0776c-d2aa-4b6e-9ede-235614a07a80", "name": "Listener IDs (Campaign)", "request": { "name": "Listener IDs (Campaign)", "description": { "content": "**Note:** only prefix impressions are included.\n\nAnonymized listener IDs for a campaign's episodes, each with its number of listens.\n\n\n > This endpoint utilizes a task system.\n >\n > Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n > to understand how it works.\n\n**Note:**\nYou can only pull Listener IDs from the last 90 days.\n\n**At least one of the following query parameters is required:**\n- `id`\n- `external_lookup_name`\n- `placed_name`\n- `external_id`\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|----------|--------|--------------|--------------------------------------------------|\n| User Id | string | abcd1234efgh | An anonymized listener identifier. |\n| Frequency| number | 4 | Number of qualifying listens for that listener. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "campaignshow", "impression-listeners" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "id", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f", "description": "The campaign show id to get data for" }, { "disabled": false, "key": "external_lookup_name", "value": "string", "description": "The campaign show external_lookup_name to get data for" }, { "disabled": false, "key": "placed_name", "value": "string", "description": "The campaign show placed_name to get data for" }, { "disabled": false, "key": "external_id", "value": "string", "description": "The campaign show external_id to get data for" }, { "disabled": false, "key": "advertiser", "value": "string", "description": "(Required) The advertiser to get data for" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b88451d9-b64a-401e-8dc1-8c1497b6aa4f", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "campaignshow", "impression-listeners" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f" }, { "key": "external_lookup_name", "value": "string" }, { "key": "placed_name", "value": "string" }, { "key": "external_id", "value": "string" }, { "key": "advertiser", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22b37c37-f011-4611-a44d-aec679101a93", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "api", "public", "campaignshow", "impression-listeners" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f" }, { "key": "external_lookup_name", "value": "string" }, { "key": "placed_name", "value": "string" }, { "key": "external_id", "value": "string" }, { "key": "advertiser", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a7817db1-791a-49a4-bfa6-5af1a4661144", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "campaignshow", "impression-listeners" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "id", "value": "ca1e7591-fe00-ea93-d659-142002d78a4f" }, { "key": "external_lookup_name", "value": "string" }, { "key": "placed_name", "value": "string" }, { "key": "external_id", "value": "string" }, { "key": "advertiser", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e567eb69-08be-49ef-b68c-ef4892930750", "name": "Audience Size by Month", "request": { "name": "Audience Size by Month", "description": { "content": "**Note:** only prefix impressions are included.\n\nPrefix downloads, unique reach and episodes published for a show, by month.\n\n\n > This endpoint utilizes a task system.\n >\n > Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n > to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|--------------------|--------|------------|-----------------------------------------------------|\n| Date | string | 2026-04-01 | Month bucket in YYYY-MM-DD format. |\n| Prefix Downloads | number | 128450 | Prefix download count for episodes in that month. |\n| Unique reach | number | 84210 | Estimated unique reach for that month. |\n| Episodes Published | number | 12 | Number of episodes published for the show that month. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "series", "audience-size", ":podscribe_show_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "advertiser", "value": "string", "description": "The advertiser to get data for" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_show_id", "description": "(Required) The Podscribe show ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "db6e607d-2f36-49e1-be0e-8a31a8e1a021", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "series", "audience-size", ":podscribe_show_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_show_id", "description": "(Required) The Podscribe show ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7115209d-5cf6-4a96-a6e4-2d83244bd04a", "name": "Unprocessable Entity", "originalRequest": { "url": { "path": [ "api", "public", "series", "audience-size", ":podscribe_show_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_show_id", "description": "(Required) The Podscribe show ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0eec7f3e-4bbd-4b5d-b832-d32fcf081f7f", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "series", "audience-size", ":podscribe_show_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "advertiser", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "podscribe_show_id", "description": "(Required) The Podscribe show ID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bfd51033-91a7-4dd0-9139-588699f4255f", "name": "Create Show", "request": { "name": "Create Show", "description": { "content": "1. Create a new show by providing an Itunes ID or YouTube URL.\n\n2. Example of seriesPlatformId values:\n\n- https://www.youtube.com/channel/UCJ5v_MCY6GNUBTO8-D3XoAg - for channels\n\n- https://www.youtube.com/playlist?list=PL5LJy9yNk3J5Kj4EJ8Z2J6QJ1Zqy2Q0Qv - for playlists\n\n- 123456789 - for Itunes ID\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"seriesPlatformId\": \"string\",\n \"publisherLookupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0bde581f-8025-4606-a0c2-763b4decdd9a", "name": "Show created", "originalRequest": { "url": { "path": [ "api", "public", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"seriesPlatformId\": \"string\",\n \"publisherLookupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"showId\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6e004e8-8d98-4ed5-9f39-c09bb0b342af", "name": "Error", "originalRequest": { "url": { "path": [ "api", "public", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"seriesPlatformId\": \"string\",\n \"publisherLookupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "635e8f4c-7053-476b-890d-f8c7f13c709d", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"seriesPlatformId\": \"string\",\n \"publisherLookupName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4213fe43-844f-47f2-8832-2db456325e51", "name": "Transcription", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "34c5092c-82e2-41b6-b4e7-03c945fd40de", "name": "Download Transcript", "request": { "name": "Download Transcript", "description": { "content": "Returns an episode's transcript and transcription status, with episode and show details.\n\n**Getting a transcript**\n\n1. Call with `start_if_missing=true`. If the episode has not been transcribed yet, this starts\n a transcription job and `transcription.status` comes back as `Running`.\n2. Call again until `transcription.status` is `Done` or `Failed`.\n3. When it is `Done`, read `transcription.text`.\n\n| Status | Meaning |\n|--------------|--------------------------------------------------------------------------------|\n| `NotStarted` | The episode has not been transcribed. Send `start_if_missing=true` to start. |\n| `Running` | Transcription is in progress. |\n| `Done` | The transcript is ready in `transcription.text`. |\n| `Failed` | Transcription failed. `start_if_missing` does not restart it; contact support. |\n\nIf no episode matches `itunes_or_yt_id` and `guid`, the response is `200` with an empty object `{}`.\n\n**Reading `transcription.text`**\n\n`transcription.text` is always a string. With `format=text` it is the transcript as plain text.\nWith `format=timestamps` (the default) it is a JSON array of word objects encoded as a string,\nso parse it a second time:\n\n```js\nconst words = JSON.parse(response.transcription.text);\n```\n\nUntil the status is `Done`, `text` is `\"[]\"` with `format=timestamps` and `\"\"` with `format=text`.\n\nEach word object has these fields:\n\n| Field | Type | Example | Description |\n|--------------|-------------------|---------|-------------------------------------------------------------------|\n| `word` | string | `Hello` | The transcribed word. |\n| `startTime` | number | `0.075` | When the word starts, in seconds from the beginning of the audio. |\n| `endTime` | number | `0.365` | When the word ends, in seconds from the beginning of the audio. |\n| `confidence` | number | `0.99` | Transcription confidence, from 0 to 1. |\n| `speaker` | integer or string | `0` | Speaker label within this episode. Some transcripts give it as a numeric string, such as `\"0\"`. Words inside a detected ad have `\"ADVERTISER\"`. |\n| `isAd` | boolean | `true` | `true` on words inside a detected ad. Absent on other words. |\n\n**Daily limit**\n\nEach transcription job that `start_if_missing` starts counts toward a limit of 1,000 jobs per\norganization per UTC day. Calls that start no job, because the episode is already `Running`,\n`Done` or `Failed` or no episode matches, do not count. Over the limit, the call returns `429`.", "type": "text/plain" }, "url": { "path": [ "api", "public", "episode", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "itunes_or_yt_id", "value": "1200361736", "description": "(Required) The show the episode belongs to: its Apple Podcasts (iTunes) ID, such as `1200361736`, or its YouTube channel ID (`UC…`) or playlist ID (`PL…`)." }, { "disabled": false, "key": "guid", "value": "string", "description": "(Required) The episode's GUID, the `` of the episode's item in the show's RSS feed." }, { "disabled": false, "key": "format", "value": "timestamps", "description": "How `transcription.text` is returned. `timestamps`: a JSON string of word objects with timings and speaker labels. `text`: the words joined into one plain-text string." }, { "disabled": false, "key": "start_if_missing", "value": "false", "description": "Start transcribing the episode if its status is `NotStarted`; the response then has status `Running`. Has no effect when the status is already `Running`, `Done` or `Failed`, so it is safe to send on every call. Each job it starts counts toward the daily limit." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8ef98d98-fb0e-4feb-99cb-58e62eccacf6", "name": "The episode with its transcription. An empty object `{}` when no episode matches.", "originalRequest": { "url": { "path": [ "api", "public", "episode", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "itunes_or_yt_id", "value": "1200361736" }, { "key": "guid", "value": "string" }, { "key": "format", "value": "timestamps" }, { "key": "start_if_missing", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 123456789,\n \"title\": \"Episode 42: Hello world\",\n \"guid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"description\": \"In this episode we say hello.\",\n \"duration\": 1830,\n \"url\": \"https://example.com/episodes/42.mp3\",\n \"seriesId\": 98765,\n \"artist\": \"Example Media\",\n \"seriesLogoUrl\": \"https://example.com/logo.jpg\",\n \"seriesRssUrl\": \"https://example.com/feed.xml\",\n \"seriesTitle\": \"Example Show\",\n \"seriesItunesId\": \"1200361736\",\n \"categories\": \"News,Daily News\",\n \"transcription\": {\n \"status\": \"Done\",\n \"text\": \"[{\\\"word\\\":\\\"Hello\\\",\\\"startTime\\\":0.075,\\\"endTime\\\":0.365,\\\"confidence\\\":0.99,\\\"speaker\\\":0},{\\\"word\\\":\\\"world\\\",\\\"startTime\\\":0.385,\\\"endTime\\\":0.505,\\\"confidence\\\":0.97,\\\"speaker\\\":0},{\\\"word\\\":\\\"Try\\\",\\\"startTime\\\":61.2,\\\"endTime\\\":61.41,\\\"confidence\\\":0.98,\\\"speaker\\\":\\\"ADVERTISER\\\",\\\"isAd\\\":true}]\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d4062d1-0cd9-4bab-915e-a1b480fe5316", "name": "A required query parameter is missing or invalid. `errors` lists the problems by parameter.", "originalRequest": { "url": { "path": [ "api", "public", "episode", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "itunes_or_yt_id", "value": "1200361736" }, { "key": "guid", "value": "string" }, { "key": "format", "value": "timestamps" }, { "key": "start_if_missing", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 400,\n \"message\": \"Invalid request URL query params\",\n \"errors\": {\n \"key_0\": [\n \"string\",\n \"string\"\n ],\n \"key_1\": [\n \"string\",\n \"string\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3552d2e-5e0e-407a-b98a-ec257ed3f61d", "name": "The token is missing or invalid, or API access is disabled for the account.", "originalRequest": { "url": { "path": [ "api", "public", "episode", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "itunes_or_yt_id", "value": "1200361736" }, { "key": "guid", "value": "string" }, { "key": "format", "value": "timestamps" }, { "key": "start_if_missing", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Invalid token\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19792d9e-7c17-4d12-acf4-be0a069aeaa1", "name": "`start_if_missing` would start a job, but the organization has reached today's limit of transcription jobs. The limit resets at 00:00 UTC.", "originalRequest": { "url": { "path": [ "api", "public", "episode", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "itunes_or_yt_id", "value": "1200361736" }, { "key": "guid", "value": "string" }, { "key": "format", "value": "timestamps" }, { "key": "start_if_missing", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 429,\n \"message\": \"Daily transcript job limit exceeded. Please contact support.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9fa378b-6247-4aad-aafc-89641d49081d", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "episode", "transcript" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "itunes_or_yt_id", "value": "1200361736" }, { "key": "guid", "value": "string" }, { "key": "format", "value": "timestamps" }, { "key": "start_if_missing", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statusCode\": 500,\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e67001f8-afd9-494f-8ecc-c3bf392f5e60", "name": "Search Episodes", "request": { "name": "Search Episodes", "description": { "content": "Search for episodes by query string. Supports searching in episode titles, descriptions, and transcripts.", "type": "text/plain" }, "url": { "path": [ "api", "public", "episode", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search", "value": "string", "description": "(Required) Search query string" }, { "disabled": false, "key": "timeFrame", "value": "31", "description": "Number of days to look back." }, { "disabled": false, "key": "exact", "value": "false", "description": "Enable exact match search." }, { "disabled": false, "key": "transcriptOnly", "value": "false", "description": "Search only in transcripts, not in titles/descriptions." }, { "disabled": false, "key": "excludeAds", "value": "false", "description": "Exclude ads from search results." }, { "disabled": false, "key": "showFilterIds", "value": "7941", "description": "Filter episodes by multiple show IDs (array)" }, { "disabled": false, "key": "showFilterIds", "value": "4704", "description": "Filter episodes by multiple show IDs (array)" }, { "disabled": false, "key": "mediaType", "value": "radio", "description": "Filter episodes by media type. Can be a single value or array. If 'all' is included, no filter is applied." }, { "disabled": false, "key": "mediaType", "value": "radio", "description": "Filter episodes by media type. Can be a single value or array. If 'all' is included, no filter is applied." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2ec9d2e3-41cb-4f47-8172-02e93238f19b", "originalRequest": { "url": { "path": [ "api", "public", "episode", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "timeFrame", "value": "31" }, { "key": "exact", "value": "false" }, { "key": "transcriptOnly", "value": "false" }, { "key": "excludeAds", "value": "false" }, { "key": "showFilterIds", "value": "7822" }, { "key": "showFilterIds", "value": "9662" }, { "key": "mediaType", "value": "radio_show" }, { "key": "mediaType", "value": "all" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"podcast\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"uploadedAt\": \"1955-03-16T04:13:44.640Z\",\n \"url\": \"string\",\n \"seriesId\": 4800,\n \"seriesTitle\": \"string\",\n \"seriesPlatform\": \"string\",\n \"seriesLogoUrl\": \"string\",\n \"seriesSmallLogoUrl\": \"string\",\n \"artist\": \"string\",\n \"numListens\": 6572,\n \"numRatings\": 830\n },\n \"highlights\": {\n \"title\": [\n \"string\",\n \"string\"\n ],\n \"description\": [\n \"string\",\n \"string\"\n ],\n \"transcript\": [\n {\n \"phrase\": \"string\",\n \"startTime\": 1190.9361962099197,\n \"term\": \"string\",\n \"ts\": 6910.39096819291,\n \"context\": \"string\"\n },\n {\n \"phrase\": \"string\",\n \"startTime\": 2276.210996108017,\n \"term\": \"string\",\n \"ts\": 7118.115025060605,\n \"context\": \"string\"\n }\n ]\n },\n \"score\": 8438.9483774994\n },\n {\n \"podcast\": {\n \"id\": \"string\",\n \"title\": \"string\",\n \"description\": \"string\",\n \"uploadedAt\": \"2018-08-26T12:48:23.762Z\",\n \"url\": \"string\",\n \"seriesId\": 3349,\n \"seriesTitle\": \"string\",\n \"seriesPlatform\": \"string\",\n \"seriesLogoUrl\": \"string\",\n \"seriesSmallLogoUrl\": \"string\",\n \"artist\": \"string\",\n \"numListens\": 6217,\n \"numRatings\": 3029\n },\n \"highlights\": {\n \"title\": [\n \"string\",\n \"string\"\n ],\n \"description\": [\n \"string\",\n \"string\"\n ],\n \"transcript\": [\n {\n \"phrase\": \"string\",\n \"startTime\": 5132.827177475086,\n \"term\": \"string\",\n \"ts\": 9246.157769577909,\n \"context\": \"string\"\n },\n {\n \"phrase\": \"string\",\n \"startTime\": 229.85760074398564,\n \"term\": \"string\",\n \"ts\": 5749.726734719967,\n \"context\": \"string\"\n }\n ]\n },\n \"score\": 8182.205532119018\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9eba89c3-094b-4804-aca2-0f5c0da5f649", "name": "Invalid search query parameter", "originalRequest": { "url": { "path": [ "api", "public", "episode", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "timeFrame", "value": "31" }, { "key": "exact", "value": "false" }, { "key": "transcriptOnly", "value": "false" }, { "key": "excludeAds", "value": "false" }, { "key": "showFilterIds", "value": "7822" }, { "key": "showFilterIds", "value": "9662" }, { "key": "mediaType", "value": "radio_show" }, { "key": "mediaType", "value": "all" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5261f3b3-0a19-4510-af63-f54d3f1bf600", "name": "Unexpected error", "originalRequest": { "url": { "path": [ "api", "public", "episode", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "string" }, { "key": "timeFrame", "value": "31" }, { "key": "exact", "value": "false" }, { "key": "transcriptOnly", "value": "false" }, { "key": "excludeAds", "value": "false" }, { "key": "showFilterIds", "value": "7822" }, { "key": "showFilterIds", "value": "9662" }, { "key": "mediaType", "value": "radio_show" }, { "key": "mediaType", "value": "all" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "363de364-32c1-4df6-ab24-91dbbf3bde61", "name": "Publishers", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "6a1ddda4-9fc5-4bbf-8c68-060dd9e64e62", "name": "Audience Size", "request": { "name": "Audience Size", "description": { "content": "Returns the same data as the Aud. Size tab (Episodes Totals CSV).\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|----------------------|--------|--------------------|-------------------------------------------------------------------|\n| Series | string | The Daily | Name of the series or show. |\n| Episode | string | Friday Roundup | Episode title. |\n| uploadedAt | string | 04/22/2026 | Episode publish/upload date in MM/DD/YYYY format. |\n| Total Impressions | number | 125000 | Sum of RSS, YouTube, Rumble, and Spotify impressions for the episode. |\n| RSS Impressions | number | 84000 | Podcast/RSS impressions for the episode. |\n| YT Impressions | number | 26000 | YouTube views for the episode. |\n| Rumble Impressions | number | 9000 | Rumble views for the episode. |\n| Spotify Impressions | number | 6000 | Spotify video impressions for the episode. |\n| reach | number | 42000 | Estimated reach for the episode. |\n| avgFrequency | number | 2.98 | Average frequency for the episode. |\n| ads | number | 3 | Number of ads detected for the episode. |\n| d15 | number | 54000 | Podcast/RSS impressions accumulated within 15 days of publish. |\n| d30 | number | 71000 | Podcast/RSS impressions accumulated within 30 days of publish. |\n| d45 | number | 79000 | Podcast/RSS impressions accumulated within 45 days of publish. |\n| d60 | number | 84000 | Podcast/RSS impressions accumulated within 60 days of publish. |\n| d15 YouTube | number | 12000 | YouTube views accumulated within 15 days of publish. |\n| d30 YouTube | number | 19000 | YouTube views accumulated within 30 days of publish. |\n| d45 YouTube | number | 23000 | YouTube views accumulated within 45 days of publish. |\n| d60 YouTube | number | 26000 | YouTube views accumulated within 60 days of publish. |\n| d15 Rumble | number | 3500 | Rumble views accumulated within 15 days of publish. |\n| d30 Rumble | number | 6000 | Rumble views accumulated within 30 days of publish. |\n| d45 Rumble | number | 7600 | Rumble views accumulated within 45 days of publish. |\n| d60 Rumble | number | 9000 | Rumble views accumulated within 60 days of publish. |\n| d15 Spotify | number | 2200 | Spotify video impressions accumulated within 15 days of publish. |\n| d30 Spotify | number | 3900 | Spotify video impressions accumulated within 30 days of publish. |\n| d45 Spotify | number | 5200 | Spotify video impressions accumulated within 45 days of publish. |\n| d60 Spotify | number | 6000 | Spotify video impressions accumulated within 60 days of publish. |\n| Length | string | 01:02:35 | Episode duration formatted as HH:MM:SS. |\n| YT Engaged Impressions | number | 10140 | YouTube Engaged Views for the episode (analytics or estimated). |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "reports", "audience" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2003-01-03\",\n \"endDate\": \"1978-06-16\",\n \"name\": \"string\",\n \"show\": [\n \"string\",\n \"string\"\n ],\n \"impressionGeo\": [\n \"string\",\n \"string\"\n ],\n \"mediaType\": [\n \"Podcast\",\n \"Youtube\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4be500f7-59d7-45bf-9877-25562d2ed782", "name": "OK. Returns a file processing task; poll file-processor/status/{id} then download CSV.", "originalRequest": { "url": { "path": [ "api", "public", "reports", "audience" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": \"1955-10-28\",\n \"endDate\": \"1959-03-30\",\n \"name\": \"string\",\n \"show\": [\n \"string\",\n \"string\"\n ],\n \"impressionGeo\": [\n \"string\",\n \"string\"\n ],\n \"mediaType\": [\n \"Display\",\n \"CTV / OTT\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "068f3640-4c5e-45ef-a543-1b1d33fe8a0b", "name": "Invalid request (e.g. invalid dates or validation error)", "originalRequest": { "url": { "path": [ "api", "public", "reports", "audience" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": \"1955-10-28\",\n \"endDate\": \"1959-03-30\",\n \"name\": \"string\",\n \"show\": [\n \"string\",\n \"string\"\n ],\n \"impressionGeo\": [\n \"string\",\n \"string\"\n ],\n \"mediaType\": [\n \"Display\",\n \"CTV / OTT\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b94a3056-b7f6-4113-aa27-e61b86bb0ad6", "name": "Forbidden (invalid token or not a publisher)", "originalRequest": { "url": { "path": [ "api", "public", "reports", "audience" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": \"1955-10-28\",\n \"endDate\": \"1959-03-30\",\n \"name\": \"string\",\n \"show\": [\n \"string\",\n \"string\"\n ],\n \"impressionGeo\": [\n \"string\",\n \"string\"\n ],\n \"mediaType\": [\n \"Display\",\n \"CTV / OTT\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9863bfb8-3bae-4264-b118-4d874183a8bd", "name": "Unexpected error", "originalRequest": { "url": { "path": [ "api", "public", "reports", "audience" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"startDate\": \"1955-10-28\",\n \"endDate\": \"1959-03-30\",\n \"name\": \"string\",\n \"show\": [\n \"string\",\n \"string\"\n ],\n \"impressionGeo\": [\n \"string\",\n \"string\"\n ],\n \"mediaType\": [\n \"Display\",\n \"CTV / OTT\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b7f872a5-a808-4e90-a5d0-ac571d233a65", "name": "Advertisers", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "eefc2de8-28b7-4a5e-b741-7da35b59f3d8", "name": "Estimated Spend by Day", "request": { "name": "Estimated Spend by Day", "description": { "content": "Estimated ad spend per advertiser and day, split by host-read and producer-read ads.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|-----------------------|----------|-----------------------|----------------------------------------------------------------------------------------------------------|\n| Day | string | 2023-12-23T00:00:00.000Z | Date of the day as an ISO 8601 timestamp. |\n| Advertiser | string | demoAdvertiser | Name of the advertiser for the media content. |\n| Estimated Spend | number | 123 | Estimated spend\n| Read By | string | Host | Read by, can be Host or Producer.\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "advertisers", "estimated-spend-by-day" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"name\": \"string\",\n \"startDate\": \"2000-05-26\",\n \"endDate\": \"2001-12-28\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6517c699-26d1-4bbc-b025-efc86de770b7", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "estimated-spend-by-day" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"name\": \"string\",\n \"startDate\": \"1964-02-01\",\n \"endDate\": \"2003-10-23\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2f5f99e-4769-4ac3-934b-3fcd853412ba", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "estimated-spend-by-day" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"name\": \"string\",\n \"startDate\": \"1964-02-01\",\n \"endDate\": \"2003-10-23\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15ef221b-17ae-4d0c-ad9a-94e5a93cfaa3", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "estimated-spend-by-day" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"name\": \"string\",\n \"startDate\": \"1964-02-01\",\n \"endDate\": \"2003-10-23\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "322fac7d-3844-4d70-b4b9-9ef9fe74e3a0", "name": "Estimated Spend by Show", "request": { "name": "Estimated Spend by Show", "description": { "content": "Estimated ad spend, ads and episodes per advertiser, show and day, split by host-read and producer-read ads.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|-----------------------|----------|-----------------------|----------------------------------------------------------------------------------------------------------|\n| Day | string | 2023-12-23T00:00:00.000Z | Date of the day as an ISO 8601 timestamp. |\n| Advertiser | string | demoAdvertiser | Name of the advertiser for the media content. |\n| Show | string | The Show | Name of the show.\n| Estimated Spend | number | 123 | Estimated spend\n| Transcript | string | https://example.com | URL to the show's episode transcript\n| Ads | number | 5 | Count of ads for the show per day.\n| Episodes | number | 10 | Count of episodes for the show per day.\n| Genres | string | Investing,Business | Genres of the show.\n| Read By | string | Host | Read by, can be Host or Producer.\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "advertisers", "estimated-spend-by-show-by-day" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"name\": \"string\",\n \"startDate\": \"2000-05-26\",\n \"endDate\": \"2001-12-28\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ca4c67d0-3422-41aa-9df6-3a419e448ace", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "estimated-spend-by-show-by-day" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"name\": \"string\",\n \"startDate\": \"1964-02-01\",\n \"endDate\": \"2003-10-23\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df088464-3f9e-4f2c-9b80-b6a3bb48d26e", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "estimated-spend-by-show-by-day" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"name\": \"string\",\n \"startDate\": \"1964-02-01\",\n \"endDate\": \"2003-10-23\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "61104ccb-9612-4faf-a1e0-58b5b3dae05e", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "estimated-spend-by-show-by-day" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertisers\": [\n \"string\",\n \"string\"\n ],\n \"name\": \"string\",\n \"startDate\": \"1964-02-01\",\n \"endDate\": \"2003-10-23\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e9663bd-1465-49a9-b029-83056e52452d", "name": "Individual Ads", "request": { "name": "Individual Ads", "description": { "content": "\nIndividual ad rows for one advertiser, same data set as the advertiser page \"Individual Ads\" download.\n\nAvailable for Pro users with API access.", "type": "text/plain" }, "url": { "path": [ "api", "public", "advertisers", "individual-ads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"limit\": 500,\n \"offset\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "82125d93-0e70-4958-916a-ceb0f8703788", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "individual-ads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"limit\": 500,\n \"offset\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"headers\": [\n {\n \"id\": \"genre\",\n \"name\": \"read_score\"\n },\n {\n \"id\": \"network\",\n \"name\": \"episode_url_in_feed\"\n }\n ],\n \"data\": [\n {\n \"published_at\": \"2025-01-15\",\n \"download_at\": \"2025-01-20 13:45\",\n \"network\": \"Wondery\",\n \"position\": \"mid\",\n \"read_type\": \"Host\",\n \"read_score\": 94,\n \"podcast_title\": \"Example Show\",\n \"episode_title\": \"Episode 123\",\n \"transcript\": \"Try acme.com slash pod...\",\n \"start_time\": \"00:10:25\",\n \"end_time\": \"00:10:55\",\n \"ad_length\": \"00:00:30\",\n \"genre\": \"Business,Investing\",\n \"episode_duration\": \"00:45:12\",\n \"podcast_rank\": 4.7,\n \"apple_podcast_id\": \"123456789\",\n \"product\": \"Premium Plan\",\n \"link\": \"https://...\",\n \"estimated_impressions\": 45000,\n \"estimated_spend\": 1200,\n \"media_type\": \"podcast\",\n \"podcast_show_id\": 12345,\n \"youtube_show_id\": 67890,\n \"youtube_video_views\": 41250,\n \"episode_url_in_feed\": \"https://www.youtube.com/watch?v=EQOzxvLp4qg\",\n \"show_first_transcribed_at\": \"2026-02-12\"\n },\n {\n \"published_at\": \"2025-01-15\",\n \"download_at\": \"2025-01-20 13:45\",\n \"network\": \"Wondery\",\n \"position\": \"mid\",\n \"read_type\": \"Host\",\n \"read_score\": 94,\n \"podcast_title\": \"Example Show\",\n \"episode_title\": \"Episode 123\",\n \"transcript\": \"Try acme.com slash pod...\",\n \"start_time\": \"00:10:25\",\n \"end_time\": \"00:10:55\",\n \"ad_length\": \"00:00:30\",\n \"genre\": \"Business,Investing\",\n \"episode_duration\": \"00:45:12\",\n \"podcast_rank\": 4.7,\n \"apple_podcast_id\": \"123456789\",\n \"product\": \"Premium Plan\",\n \"link\": \"https://...\",\n \"estimated_impressions\": 45000,\n \"estimated_spend\": 1200,\n \"media_type\": \"podcast\",\n \"podcast_show_id\": 12345,\n \"youtube_show_id\": 67890,\n \"youtube_video_views\": 41250,\n \"episode_url_in_feed\": \"https://www.youtube.com/watch?v=EQOzxvLp4qg\",\n \"show_first_transcribed_at\": \"2026-02-12\"\n }\n ],\n \"pagination\": {\n \"limit\": 8294,\n \"offset\": 285,\n \"total\": 3987\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38750ad2-9e8a-4e74-b20d-b369bc833eb2", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "individual-ads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"limit\": 500,\n \"offset\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a403e01-fcf1-432f-84a2-01d41c7d36a9", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "individual-ads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"limit\": 500,\n \"offset\": 0\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fcc67973-b331-47ed-90ae-fec306484b24", "name": "Advertiser Overview", "request": { "name": "Advertiser Overview", "description": { "content": "\nReturns the advertiser summary shown at the top of the advertiser page, plus the estimated spend\nper month for the advertiser and for each of its competitors, the same data as the advertiser\npage \"Similar\" tab. The response is returned directly, without the task system.\n\nAny advertiser tracked by Podscribe can be requested; it does not need to be linked to your account.\n\nThis endpoint is available for Pro users with API access.\n\nRules:\n\n- One advertiser per request. A value holding more than one name returns 400.\n- `advertiser` is at most 200 characters.\n- `startDate` and `endDate` go together. Sending one without the other returns 400.\n- Spend is bucketed by calendar month, but the range is honoured to the day: the first and last\n buckets hold only the days inside the range, and the summary counters cover the same days.\n- A range touching more than 36 calendar months returns 400. A range whose start month is later\n than the current one covers no full month and returns 400 as well.\n- 30 requests per minute per user. Beyond that the endpoint returns 429 with `Retry-After`.", "type": "text/plain" }, "url": { "path": [ "api", "public", "advertisers", "overview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"countryCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "63a65be6-0ccc-4cea-a814-4b3b3c69a323", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "overview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"countryCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"advertiser\": {\n \"lookupName\": \"betterhelp\",\n \"name\": \"BetterHelp\",\n \"estSpend\": 12345678,\n \"prevEstSpend\": 11000000,\n \"episodeCount\": 4321,\n \"prevEpisodeCount\": 4000,\n \"seriesCount\": 812,\n \"prevSeriesCount\": 790,\n \"seriesWithHostReadsCount\": 500,\n \"spendByMonth\": [\n {\n \"month\": \"2026-08\",\n \"estSpend\": 120000,\n \"episodeCount\": 300,\n \"seriesCount\": 90\n },\n {\n \"month\": \"2026-08\",\n \"estSpend\": 120000,\n \"episodeCount\": 300,\n \"seriesCount\": 90\n }\n ]\n },\n \"competitors\": [\n {\n \"lookupName\": \"talkspace\",\n \"name\": \"Talkspace\",\n \"spendByMonth\": [\n {\n \"month\": \"2026-08\",\n \"estSpend\": 45000\n },\n {\n \"month\": \"2026-08\",\n \"estSpend\": 45000\n }\n ]\n },\n {\n \"lookupName\": \"talkspace\",\n \"name\": \"Talkspace\",\n \"spendByMonth\": [\n {\n \"month\": \"2026-08\",\n \"estSpend\": 45000\n },\n {\n \"month\": \"2026-08\",\n \"estSpend\": 45000\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1a6139b-d35b-45b6-955c-3ae33bef3f6b", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "overview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"countryCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "229673cf-6368-455b-bce0-2f1a7f373592", "name": "Advertiser not found", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "overview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"countryCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "98917b81-634a-4c8c-9ae1-b941f2a2a1c3", "name": "More than 30 requests in a minute from the same user.", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "overview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"countryCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8a157678-b838-4968-a1f7-e1b5eb05442b", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "advertisers", "overview" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiser\": \"string\",\n \"startDate\": \"string\",\n \"endDate\": \"string\",\n \"countryCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04edcfed-5bd4-4014-9e6c-645845f6034a", "name": "Create Advertiser", "request": { "name": "Create Advertiser", "description": { "content": "Create a new advertiser or return an existing one if it already exists.\n\nProvide either `advertiserName` or `itunesId`, but not both. When `itunesId` is provided, the endpoint\nresolves or creates the show and returns the Smart Promo advertiser tied to that show.\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b29a4c16-08dc-43eb-b49d-46b2811db500", "name": "Successfully created or retrieved advertiser", "originalRequest": { "url": { "path": [ "api", "public", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"advertiserName\": \"string\",\n \"lookupName\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f5de03d-5f6b-44ff-ac31-6a404d921c30", "name": "Invalid request data", "originalRequest": { "url": { "path": [ "api", "public", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4cf6e2ea-6aec-4da6-98e7-d4ba7cfeb216", "name": "Invalid token or insufficient permissions", "originalRequest": { "url": { "path": [ "api", "public", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8dbc2cbb-0255-4efb-b775-e6f798792790", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "public", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6e125fac-ae41-4926-aada-7d96d29f6027", "name": "Ranker", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "1f2741c8-1301-4e68-a0ac-c2d51bc1cca6", "name": "Top Publishers", "request": { "name": "Top Publishers", "description": { "content": "Publishers ranked by estimated monthly audio reach, with show counts, downloads and ad load.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|-------------------------------|----------|------------|-----------------------------------------------------------------|\n| Rank | number | 1 | Ranking of the publisher based on performance metrics. |\n| Publisher | string | PublisherName | Name of the podcast publisher or network. |\n| # of Shows | number | 100 | Total number of distinct shows under this publisher. |\n| Top Shows | string | Show A, Show B | The publisher's top shows, comma-separated. |\n| Estimated Monthly Audio Reach | number | 1231232 | Estimated number of unique listeners reached per month. |\n| Monthly Downloads & Views | number | 1232323 | Sum of monthly downloads and views across all shows. |\n| Podcast Downloads | number | 1100000 | Monthly podcast downloads across all shows. |\n| Streaming Impressions | number | 50000 | Monthly streaming impressions across all shows. |\n| YouTube Views | number | 80000 | YouTube views in the last month across all shows. |\n| Monthly YouTube Comments | number | 1200 | YouTube comments in the last month across all shows. |\n| Monthly YouTube Likes | number | 9000 | YouTube likes in the last month across all shows. |\n| Rumble Views | number | 3000 | Rumble views in the last month across all shows. |\n| Spotify Monthly Streams | number | 20000 | Spotify streams in the last month across all shows. |\n| Monthly Social Views | number | 40000 | Social platform views in the last month across all shows. |\n| Monthly Social Comments | number | 500 | Social platform comments in the last month across all shows. |\n| Monthly Social Likes | number | 7000 | Social platform likes in the last month across all shows. |\n| Host Read % | string | 45.5% | Share of the publisher's ads read by the host. |\n| Dir. Res. % | string | 60.25% | Share of the publisher's advertisers that are direct response. |\n| Ad Load | string | 5.32% | Average ad load across this publisher's shows, as a percentage. |\n| Top Advertisers | string | Advertiser1, Advertiser2 | The publisher's top 3 advertisers by estimated spend. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "ranker", "publishers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"limit\": 250\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f08ad4ce-5548-45df-8ac8-b6a92f28fa34", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "ranker", "publishers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"limit\": 250\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb7b47e0-1217-4ba5-82c6-0a4ba462f33e", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "ranker", "publishers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"limit\": 250\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c4bd6d96-daaf-4d8e-bcd2-0844140b3779", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "ranker", "publishers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"limit\": 250\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee484bce-493b-4d68-8a43-a359a4e2da66", "name": "Top Shows", "request": { "name": "Top Shows", "description": { "content": "Shows ranked by the `sortBy` metric, with audience, ad and demographic details.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|--------------------------------------|----------|------------------------------|----------------------------------------------------------------------------------------------------------|\n| Rank | number | 1 | Ranking of the show in the dataset. |\n| Show | string | The Show | Name of the podcast show. |\n| RSS Email | string | foo@bar.baz | Contact email associated with the podcast's RSS feed. |\n| Publisher | string | Publisher | Organization or company publishing the podcast. |\n| Publisher Email | string | foo@bar.baz | Contact email of the publisher. |\n| Genre | string | True Crime | Genre or category of the podcast. |\n| Content Risk | string | medium | Content safety or risk level classification. |\n| Estimated reach | number | 8335118 | Estimated number of individuals reached. |\n| Estimated downloads per episode | number | 1968697 | Estimated downloads per each episode. |\n| Estimated downloads per month | number | 18310294 | Estimated total monthly downloads across episodes. |\n| Estimated podcast downloads per episode | number | 1902865 | Estimated per-episode downloads from podcast platforms. |\n| Estimated podcast downloads per month | number | 17989350 | Estimated monthly podcast platform downloads. |\n| Estimated YouTube downloads per episode | number | 53123 | Estimated per-episode views on YouTube. |\n| Estimated YouTube downloads per month | number | 312542 | Estimated monthly views from YouTube. |\n| Estimated Spotify downloads per episode | number | 312542 | Spotify-specific episode views (if available). |\n| Estimated Spotify downloads per month | number | 312542 | Spotify-specific monthly views (if available). |\n| Estimated Rumble downloads per episode | number | 312542 | Rumble-specific episode views (if available). |\n| Estimated Rumble downloads per month | number | 312542 | Rumble-specific monthly views (if available). |\n| Number of ads | number | 1493 | Total number of ads within the dataset for this show. |\n| Ad load % | string | 14% | Ad load percentage (amount of content dedicated to ads). |\n| Renewal rate | string | 56% | Percentage of ad contracts that were renewed. |\n| Host read % | string | 69% | Percentage of ads read by the host. |\n| Direct response % | string | 57% | Share of ads optimized for direct response (e.g., promo codes). |\n| Top advertisers | string | Advertiser1,Advertiser2,... | List of top advertisers associated with the show. |\n| Male % | string | 23% | Percentage of male listeners. |\n| Average age | number | 32 | Average listener age. |\n| Average income | string | $52,755 | Average household income of listeners. |\n| Location | string | Los Angeles, CA: 4.3%... | Top listener locations with percentages. |\n| Industries | string | Education: 8.5%... | Listener industries with prevalence percentages. |\n| Occupations | string | Nurses: 2.9%,Teachers:... | Common occupations among listeners. |\n| Ethnicity | string | White/caucasian: 82.2%... | Listener ethnicity breakdown. |\n| Marital status | string | Single: 60.2%... | Breakdown of listeners by marital status. |\n| Parental status | string | Parents: 19.1% | Percentage of listeners who are parents. |\n| Simulcast YouTube series ID | number | 2517763 | Internal identifier for the show's simulcast YouTube version. |\n| First Publish | string | 2017-12-18T00:01:00.000Z | Date of the first published episode (ISO timestamp format). |\n| Last Publish | string | 2017-12-18T00:01:00.000Z | Date of the last published episode (ISO timestamp format). |\n| Last Publish (YT) | string | 2017-12-18T00:01:00.000Z | Date of the last published YouTube episode (ISO timestamp format). |\n| RSS Episodes per week | number | 1 | Average number of episodes published per week. |\n| YT Episodes per week | number | 1 | Average number of episodes published per week. |\n| RSS - Total # of Episodes | number | 100 | Total number of episodes in the RSS feed |\n| YT - Total # of Episodes | number | 100 | Total number of episodes in the YouTube feed |\n| Youtube URL | string | https://www.youtube.com/example | URL of the show on YouTube. |\n| RSS Feed URL | string | https://www.rss.com/example | URL of the RSS feed |\n| RSS Language | string | English | Language from RSS feed |\n| Country of Origin | string | United States | The country with the highest number of listeners |\n| Simulcast match percent | string | 10% | Percentage of podcast episodes also available on YouTube or Rumble |\n| L10 Simulcast match percent | string | 10% | Percentage of last 10 RSS episodes that match a YouTube video |\n| Content Detected Language | string | English | Most frequent languages from podcast episodes |\n| RSS Location | string | Los Angeles, CA: 4.3%... | The primary country/city inferred from the RSS feed metadata where available |\n| Hosting Platform | string | Megaphone | Podcast hosting platform detected from the RSS feed |\n| Opted Into Spotify Video | string | Yes | `Yes` when the show is opted into Spotify Video, `-` otherwise |\n| Tracking Set Up For Spotify Video | string | Yes | `Yes` when Spotify Video tracking is set up for the show, `-` otherwise |\n| Show URL | string | https://app.podscribe.com/show/123 | URL of the show |\n| Apple HLS Enabled | string | Yes | `Yes` when the show serves Apple HLS audio, `-` otherwise |\n| Show ID | number | 12345 | Podscribe internal identifier of the show (final segment of Show URL). |\n| YouTube Connection | string | Yes | `Yes` when YouTube Analytics is connected, `No` when not, `-` when unknown. |\n| YouTube Engaged Views Per Episode | number | 20718 | YouTube Engaged Views per episode. |\n| YouTube Engaged Views Per Month | number | 121891 | YouTube Engaged Views per month. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "ranker", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"platform\": \"podcast\",\n \"country\": \"GLOBAL\",\n \"sortBy\": \"itunesNumRatings\",\n \"limit\": 250,\n \"countryOfOrigin\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e0e4652e-dbe4-4dce-af31-61a6d400d862", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "ranker", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"platform\": \"podcast\",\n \"country\": \"GLOBAL\",\n \"sortBy\": \"youtubeEngPercentile\",\n \"limit\": 250,\n \"countryOfOrigin\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a79db400-76b5-4a5c-841a-563ef3da583d", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "ranker", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"platform\": \"podcast\",\n \"country\": \"GLOBAL\",\n \"sortBy\": \"youtubeEngPercentile\",\n \"limit\": 250,\n \"countryOfOrigin\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9718b3ad-0608-4beb-ae1c-6b2e2aa4f0a9", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "ranker", "series" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"platform\": \"podcast\",\n \"country\": \"GLOBAL\",\n \"sortBy\": \"youtubeEngPercentile\",\n \"limit\": 250,\n \"countryOfOrigin\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33feef31-7faf-4b9c-8dc3-f553e3f2b887", "name": "Top Advertisers", "request": { "name": "Top Advertisers", "description": { "content": "Advertisers ranked by estimated ad spend over the last 12 months, with ad, show and episode counts.\n\n\n> This endpoint utilizes a task system.\n>\n> Please read the description of [Get status of file processing](/reference/operations/apipublicfile-processorstatusid/)\n> to understand how it works.\n\n\n\n\nResult file format:\n| Field | Type | Example | Description |\n|---------------------------------------|----------|-----------------|-----------------------------------------------------------------------------|\n| Rank | number | 1 | Ranking of the advertiser based on spend. |\n| Brand | string | Brand_1 | Name of the advertised brand. |\n| Top Publishers | string | Publisher_1, Publisher_2 | Up to 3 top publishers of the advertiser, comma-separated. |\n| Industry | string | Industry_1 | Industry category associated with the brand. |\n| Advertiser type | string | direct | `direct` or `branding`. |\n| Estimated Spend | number | 1231231 | Estimated ad spend in USD over the last 12 months. |\n| Change % | string | 12.5% | Percent change in estimated spend, last 12 months against the previous 12. |\n| Change $ | number | 150000 | Dollar change in estimated spend, last 12 months against the previous 12. |\n| Host Read % | string | 89% | Percentage of ads that were host-read. |\n| Show count | number | 1999 | Number of distinct shows the advertiser appeared on. |\n| Show with host reads count | number | 1999 | Number of shows with host-read ads. |\n| Episode count | number | 30000 | Total number of episodes containing this advertiser's ads. |\n| Ads count | number | 45000 | Total number of ads run by this advertiser. |\n| First seen | string | 3/8/2020 | Date of the first detected ad from this advertiser. |\n| Last seen | string | 4/28/2025 | Date of the most recent detected ad from this advertiser. |\n| Top show genres | string | Genre1,Genre2 | Comma-separated list of top show genres associated with the ads. |\n| Agency | string | Agency_1 | Agencies of the advertiser, comma-separated. |\n| Child Advertiser | string | Brand_2 | Child advertisers of the advertiser, comma-separated. |\n| Parent Advertiser | string | Parent_1 | Parent advertiser of the advertiser. |\n| Lookup Name | string | brand_1 | Advertiser identifier accepted by advertiser endpoints such as Individual Ads. |\n| Advertiser Lists | string | List_1, List_2 | Comma-separated advertiser lists this brand belongs to. `-` when it belongs to none. |\n\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "ranker", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"chart\": \"rising\",\n \"limit\": 250\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "96eb77dd-1464-4919-bd92-091e955c44da", "name": "OK", "originalRequest": { "url": { "path": [ "api", "public", "ranker", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"chart\": \"rising\",\n \"limit\": 250\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a48c7880-163b-ca00-c412-ef1b7be67f0b\",\n \"status\": \"failed\",\n \"url\": \"http://nlYWQgvXhblgTxmVhO.grsauB\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "664526ea-87a8-403f-9e68-3a13403c2939", "name": "Invalid data", "originalRequest": { "url": { "path": [ "api", "public", "ranker", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"chart\": \"rising\",\n \"limit\": 250\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "16b73f0b-0739-4d6d-98d3-c0efc73dd7e3", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "ranker", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"chart\": \"rising\",\n \"limit\": 250\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ade3b689-426e-4bbb-bb91-84dba0a613c9", "name": "User Management", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "dbf1d9b0-7231-41e2-8574-3d8215671cf7", "name": "Invite Advertiser User", "request": { "name": "Invite Advertiser User", "description": { "content": "Invite a new advertiser user", "type": "text/plain" }, "url": { "path": [ "api", "public", "users", "advertisers", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\",\n \"email\": \"yrT@NJyDfy.brlc\",\n \"tabs\": [\n \"simple_campaigns\",\n \"simple_overview\"\n ],\n \"teamMembers\": [\n \"9iiiRmYe6O@mIYSSUpjoFWNNFlqixv.vnrb\",\n \"IJR2lY4UY0@uJcgHHyDDMfIS.pbko\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c89d7f15-1806-44d0-859e-25e6eb4acb9f", "name": "Successfully invited advertiser user", "originalRequest": { "url": { "path": [ "api", "public", "users", "advertisers", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\",\n \"email\": \"DTcH4Z8X@sOgWCehYgTLYsbtUMRGgvXKjUfYdgjpkm.thk\",\n \"tabs\": [\n \"simple_overview_show\",\n \"simple_campaigns\"\n ],\n \"teamMembers\": [\n \"DFIuc8bUrokyWtq@JOxLZG.yt\",\n \"V87jkGQJQ9v@ySwV.xuc\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8de5012-d408-4831-b48f-a073e1194350", "name": "Invalid request data", "originalRequest": { "url": { "path": [ "api", "public", "users", "advertisers", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\",\n \"email\": \"DTcH4Z8X@sOgWCehYgTLYsbtUMRGgvXKjUfYdgjpkm.thk\",\n \"tabs\": [\n \"simple_overview_show\",\n \"simple_campaigns\"\n ],\n \"teamMembers\": [\n \"DFIuc8bUrokyWtq@JOxLZG.yt\",\n \"V87jkGQJQ9v@ySwV.xuc\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a604db3f-5134-4290-9388-7f0294397319", "name": "Invalid token", "originalRequest": { "url": { "path": [ "api", "public", "users", "advertisers", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\",\n \"email\": \"DTcH4Z8X@sOgWCehYgTLYsbtUMRGgvXKjUfYdgjpkm.thk\",\n \"tabs\": [\n \"simple_overview_show\",\n \"simple_campaigns\"\n ],\n \"teamMembers\": [\n \"DFIuc8bUrokyWtq@JOxLZG.yt\",\n \"V87jkGQJQ9v@ySwV.xuc\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2d606d17-fe79-40ba-8c8b-731421bac658", "name": "User cannot be invited to advertiser", "originalRequest": { "url": { "path": [ "api", "public", "users", "advertisers", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\",\n \"email\": \"DTcH4Z8X@sOgWCehYgTLYsbtUMRGgvXKjUfYdgjpkm.thk\",\n \"tabs\": [\n \"simple_overview_show\",\n \"simple_campaigns\"\n ],\n \"teamMembers\": [\n \"DFIuc8bUrokyWtq@JOxLZG.yt\",\n \"V87jkGQJQ9v@ySwV.xuc\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f71a1276-ad8f-4ba3-a372-5d1a6f6fc8bf", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "public", "users", "advertisers", "invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\",\n \"email\": \"DTcH4Z8X@sOgWCehYgTLYsbtUMRGgvXKjUfYdgjpkm.thk\",\n \"tabs\": [\n \"simple_overview_show\",\n \"simple_campaigns\"\n ],\n \"teamMembers\": [\n \"DFIuc8bUrokyWtq@JOxLZG.yt\",\n \"V87jkGQJQ9v@ySwV.xuc\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20e5b31b-8c65-4da0-bad1-ec23b56116a9", "name": "Get Advertiser Members", "request": { "name": "Get Advertiser Members", "description": { "content": "Get list of team members for a specific advertiser", "type": "text/plain" }, "url": { "path": [ "api", "public", "users", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f0a597c6-7559-4e98-b428-29735e388df5", "name": "Successfully retrieved advertiser members", "originalRequest": { "url": { "path": [ "api", "public", "users", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"email\": \"ZfdARGySaeC90@CyjRELzlCHxoocuOBlKLvIOdO.nou\",\n \"invited\": \"1975-09-29T15:16:49.596Z\",\n \"status\": \"invited\"\n },\n {\n \"email\": \"2GhsbkKHLx@KfXhqnfCVwLfqumefKMtALXIIBUm.vvi\",\n \"invited\": \"1948-01-04T14:36:31.492Z\",\n \"status\": \"unknown\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92388f5b-3076-436a-9db0-882593797c15", "name": "Invalid request data", "originalRequest": { "url": { "path": [ "api", "public", "users", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b8bdb33-d8bf-4518-b411-401b5afde28e", "name": "Invalid token", "originalRequest": { "url": { "path": [ "api", "public", "users", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c14b6227-7916-4081-9b06-b9ce4fd7a080", "name": "Advertiser not found", "originalRequest": { "url": { "path": [ "api", "public", "users", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09e723af-e164-403a-a865-9940c32e9bef", "name": "Internal server error", "originalRequest": { "url": { "path": [ "api", "public", "users", "advertisers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"advertiserName\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f74106e-0312-4dfb-8b72-8fcb9a2181bb", "name": "Regenerate API Key", "request": { "name": "Regenerate API Key", "description": { "content": "**Note:** The key that authorized this request stops working as soon as the request succeeds. Other active keys on the same account stop working too. The new key is returned once in this response.\nIssue a new API key for the account that owns the key used on this request.\n", "type": "text/plain" }, "url": { "path": [ "api", "public", "users", "api-key", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "281f4567-5cbc-4aa4-ae19-2c10039fd277", "name": "The previous key is revoked and a new key is returned.", "originalRequest": { "url": { "path": [ "api", "public", "users", "api-key", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"apiKey\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf5bb761-f753-4ef6-aadf-026ea9e6ce4b", "name": "Invalid token, or the token is not an API key.", "originalRequest": { "url": { "path": [ "api", "public", "users", "api-key", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0f10cae-7745-47e2-9659-5ca45940e639", "name": "No active API key to regenerate.", "originalRequest": { "url": { "path": [ "api", "public", "users", "api-key", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "57f1500b-0959-43e6-99f3-548ab0593de8", "name": "Monthly request limit exceeded. Please contact support.", "originalRequest": { "url": { "path": [ "api", "public", "users", "api-key", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7dcafc27-5b1b-46a1-bf4e-78e4d9bca0b9", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "api", "public", "users", "api-key", "regenerate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://backend.podscribe.ai", "key": "baseUrl" }, { "key": "bearerToken", "value": "", "type": "string" } ], "info": { "_postman_id": "f2de4d5f-cd56-4b9e-8d47-fd2ef9f3d96b", "name": "Podscribe API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Welcome to the Podscribe API Documentation. This guide empowers developers with the tools to seamlessly integrate Podscribe's Verification & Attribution services into their applications, providing a robust solution for validating and attributing podcast content and campaigns.", "type": "text/plain" } } }