{ "openapi": "3.0.1", "info": { "title": "AdCritter API", "description": "Public API for managing campaigns, ads, plans, and reports.", "version": "v1" }, "paths": { "/v1/advertisers/{advertiserId}/ads/display": { "post": { "tags": [ "Ads" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CampaignId", "DestinationUrl", "File", "Name" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Name": { "type": "string" }, "CampaignId": { "type": "string" }, "DestinationUrl": { "type": "string" }, "Width": { "type": "integer", "format": "int32" }, "Height": { "type": "integer", "format": "int32" } } }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" }, "CampaignId": { "style": "form" }, "DestinationUrl": { "style": "form" }, "Width": { "style": "form" }, "Height": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/ads/native": { "post": { "tags": [ "Ads" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Body", "CallToAction", "CampaignId", "ClickUrl", "CompanyName", "File", "Headline", "Name" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "CampaignId": { "type": "string" }, "Name": { "type": "string" }, "Headline": { "type": "string" }, "Body": { "type": "string" }, "CompanyName": { "type": "string" }, "CallToAction": { "type": "string" }, "ClickUrl": { "type": "string" } } }, "encoding": { "File": { "style": "form" }, "CampaignId": { "style": "form" }, "Name": { "style": "form" }, "Headline": { "style": "form" }, "Body": { "style": "form" }, "CompanyName": { "style": "form" }, "CallToAction": { "style": "form" }, "ClickUrl": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/ads/billboard": { "post": { "tags": [ "Ads" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CampaignId", "File", "Name" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Name": { "type": "string" }, "CampaignId": { "type": "string" }, "DestinationUrl": { "type": "string" } } }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" }, "CampaignId": { "style": "form" }, "DestinationUrl": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/ads/tv": { "post": { "tags": [ "Ads" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CampaignId", "File", "Name" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Name": { "type": "string" }, "CampaignId": { "type": "string" } } }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" }, "CampaignId": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/ads/audio": { "post": { "tags": [ "Ads" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CampaignId", "File", "Name" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Name": { "type": "string" }, "CampaignId": { "type": "string" }, "ClickUrl": { "type": "string" } } }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" }, "CampaignId": { "style": "form" }, "ClickUrl": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/ads": { "get": { "tags": [ "Ads" ], "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponsePagedResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/ads/{adId}": { "get": { "tags": [ "Ads" ], "parameters": [ { "name": "adId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponseResponse" } } } } } }, "put": { "tags": [ "Ads" ], "parameters": [ { "name": "adId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdUpdateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponseResponse" } } } } } }, "delete": { "tags": [ "Ads" ], "parameters": [ { "name": "adId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/ads/{adId}/activate": { "post": { "tags": [ "Ads" ], "parameters": [ { "name": "adId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/ads/{adId}/deactivate": { "post": { "tags": [ "Ads" ], "parameters": [ { "name": "adId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponseResponse" } } } } } } }, "/v1/advertisers": { "post": { "tags": [ "Advertisers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvertiserCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdvertiserCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdvertiserCreateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvertiserResponseResponse" } } } } } }, "get": { "tags": [ "Advertisers" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvertiserResponsePagedResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}": { "get": { "tags": [ "Advertisers" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvertiserResponseResponse" } } } } } }, "put": { "tags": [ "Advertisers" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvertiserUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdvertiserUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdvertiserUpdateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvertiserResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/pixelTag": { "get": { "tags": [ "Advertisers" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvertiserPixelTagResponseResponse" } } } } } } }, "/v1/apiKeys/scopes": { "get": { "tags": [ "ApiKeyScopes" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyScopesResponseResponse" } } } } } } }, "/v1/bid-strategy-presets": { "get": { "tags": [ "BidStrategyPresets" ], "parameters": [ { "name": "campaignType", "in": "query", "schema": { "type": "string", "default": "internet" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BidStrategyPresetListResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/blueprints": { "post": { "tags": [ "Blueprints" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BlueprintCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BlueprintCreateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintResponseResponse" } } } } } }, "get": { "tags": [ "Blueprints" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintResponsePagedResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/blueprints/{blueprintId}": { "get": { "tags": [ "Blueprints" ], "parameters": [ { "name": "blueprintId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintResponseResponse" } } } } } }, "delete": { "tags": [ "Blueprints" ], "parameters": [ { "name": "blueprintId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/campaigns": { "post": { "tags": [ "Campaigns" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CampaignCreateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignResponseResponse" } } } } } }, "get": { "tags": [ "Campaigns" ], "parameters": [ { "name": "AdvertiserId", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/CampaignStatus" } }, { "name": "ActiveStatus", "in": "query", "schema": { "$ref": "#/components/schemas/CampaignActiveStatus" } }, { "name": "Query", "in": "query", "schema": { "type": "string" } }, { "name": "CreatedFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "CreatedTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ActivatedFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ActivatedTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Ids", "in": "query", "schema": { "type": "string" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignResponsePagedResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/campaigns/{campaignId}": { "get": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignResponseResponse" } } } } } }, "put": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CampaignUpdateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignResponseResponse" } } } } } }, "delete": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/campaigns/{campaignId}/geo": { "get": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoResponseResponse" } } } } } }, "put": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GeoRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/campaigns/{campaignId}/settings": { "get": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignSettingsResponseResponse" } } } } } }, "put": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CampaignSettingsRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignSettingsResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/campaigns/{campaignId}/launch": { "post": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignLaunchRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignLaunchRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CampaignLaunchRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/campaigns/{campaignId}/pause": { "post": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/campaigns/{campaignId}/resume": { "post": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/campaigns/{campaignId}/ads": { "get": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponsePagedResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/campaigns/{campaignId}/audience": { "get": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignAudienceResponseResponse" } } } } } }, "put": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignAudienceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CampaignAudienceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CampaignAudienceRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignAudienceResponseResponse" } } } } } } }, "/v1/canva/authorizeUrl": { "get": { "tags": [ "Canva" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanvaAuthorizeUrlResponseResponse" } } } } } } }, "/v1/canva/status": { "get": { "tags": [ "Canva" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanvaConnectionStatusResponseResponse" } } } } } } }, "/v1/canva/connection": { "delete": { "tags": [ "Canva" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } } } } }, "/v1/canva/designs": { "get": { "tags": [ "Canva" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "ownership", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "continuation", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanvaPassthroughResponseResponse" } } } } } } }, "/v1/canva/folders": { "get": { "tags": [ "Canva" ], "parameters": [ { "name": "folderId", "in": "query", "schema": { "type": "string" } }, { "name": "itemTypes", "in": "query", "schema": { "type": "string" } }, { "name": "continuation", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanvaPassthroughResponseResponse" } } } } } } }, "/v1/canva/brandTemplates": { "get": { "tags": [ "Canva" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "continuation", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanvaPassthroughResponseResponse" } } } } } } }, "/v1/canva/asset/{assetId}": { "get": { "tags": [ "Canva" ], "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanvaPassthroughResponseResponse" } } } } } } }, "/v1/canva/callback": { "get": { "tags": [ "CanvaCallback" ], "parameters": [ { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "error", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v1/domains": { "get": { "tags": [ "Domains" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainResponsePagedResponseResponse" } } } } } } }, "/v1/facebook/authorizeUrl": { "get": { "tags": [ "Facebook" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacebookAuthorizeUrlResponseResponse" } } } } } } }, "/v1/facebook/status": { "get": { "tags": [ "Facebook" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacebookConnectionStatusResponseResponse" } } } } } } }, "/v1/facebook/connection": { "delete": { "tags": [ "Facebook" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } } } } }, "/v1/facebook/adAccounts": { "get": { "tags": [ "Facebook" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacebookGraphPassthroughResponseResponse" } } } } } } }, "/v1/facebook/adAccounts/{adAccountId}/insights": { "get": { "tags": [ "Facebook" ], "parameters": [ { "name": "adAccountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "Level", "in": "query", "schema": { "type": "string" } }, { "name": "Filtering", "in": "query", "schema": { "type": "string" } }, { "name": "Breakdowns", "in": "query", "schema": { "type": "string" } }, { "name": "ActionBreakdowns", "in": "query", "schema": { "type": "string" } }, { "name": "ActionAttributionWindows", "in": "query", "schema": { "type": "string" } }, { "name": "ActionReportTime", "in": "query", "schema": { "type": "string" } }, { "name": "TimeRange", "in": "query", "schema": { "type": "string" } }, { "name": "TimeRanges", "in": "query", "schema": { "type": "string" } }, { "name": "TimeIncrement", "in": "query", "schema": { "type": "string" } }, { "name": "DatePreset", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Summary", "in": "query", "schema": { "type": "string" } }, { "name": "UseAccountAttributionSetting", "in": "query", "schema": { "type": "boolean" } }, { "name": "UseUnifiedAttributionSetting", "in": "query", "schema": { "type": "boolean" } }, { "name": "After", "in": "query", "schema": { "type": "string" } }, { "name": "Before", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacebookGraphPassthroughResponseResponse" } } } } } } }, "/v1/facebook/campaigns/{campaignId}/insights": { "get": { "tags": [ "Facebook" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "Level", "in": "query", "schema": { "type": "string" } }, { "name": "Filtering", "in": "query", "schema": { "type": "string" } }, { "name": "Breakdowns", "in": "query", "schema": { "type": "string" } }, { "name": "ActionBreakdowns", "in": "query", "schema": { "type": "string" } }, { "name": "ActionAttributionWindows", "in": "query", "schema": { "type": "string" } }, { "name": "ActionReportTime", "in": "query", "schema": { "type": "string" } }, { "name": "TimeRange", "in": "query", "schema": { "type": "string" } }, { "name": "TimeRanges", "in": "query", "schema": { "type": "string" } }, { "name": "TimeIncrement", "in": "query", "schema": { "type": "string" } }, { "name": "DatePreset", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Summary", "in": "query", "schema": { "type": "string" } }, { "name": "UseAccountAttributionSetting", "in": "query", "schema": { "type": "boolean" } }, { "name": "UseUnifiedAttributionSetting", "in": "query", "schema": { "type": "boolean" } }, { "name": "After", "in": "query", "schema": { "type": "string" } }, { "name": "Before", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacebookGraphPassthroughResponseResponse" } } } } } } }, "/v1/facebook/adSets/{adSetId}/insights": { "get": { "tags": [ "Facebook" ], "parameters": [ { "name": "adSetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "Level", "in": "query", "schema": { "type": "string" } }, { "name": "Filtering", "in": "query", "schema": { "type": "string" } }, { "name": "Breakdowns", "in": "query", "schema": { "type": "string" } }, { "name": "ActionBreakdowns", "in": "query", "schema": { "type": "string" } }, { "name": "ActionAttributionWindows", "in": "query", "schema": { "type": "string" } }, { "name": "ActionReportTime", "in": "query", "schema": { "type": "string" } }, { "name": "TimeRange", "in": "query", "schema": { "type": "string" } }, { "name": "TimeRanges", "in": "query", "schema": { "type": "string" } }, { "name": "TimeIncrement", "in": "query", "schema": { "type": "string" } }, { "name": "DatePreset", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Summary", "in": "query", "schema": { "type": "string" } }, { "name": "UseAccountAttributionSetting", "in": "query", "schema": { "type": "boolean" } }, { "name": "UseUnifiedAttributionSetting", "in": "query", "schema": { "type": "boolean" } }, { "name": "After", "in": "query", "schema": { "type": "string" } }, { "name": "Before", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacebookGraphPassthroughResponseResponse" } } } } } } }, "/v1/facebook/ads/{adId}/insights": { "get": { "tags": [ "Facebook" ], "parameters": [ { "name": "adId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "Level", "in": "query", "schema": { "type": "string" } }, { "name": "Filtering", "in": "query", "schema": { "type": "string" } }, { "name": "Breakdowns", "in": "query", "schema": { "type": "string" } }, { "name": "ActionBreakdowns", "in": "query", "schema": { "type": "string" } }, { "name": "ActionAttributionWindows", "in": "query", "schema": { "type": "string" } }, { "name": "ActionReportTime", "in": "query", "schema": { "type": "string" } }, { "name": "TimeRange", "in": "query", "schema": { "type": "string" } }, { "name": "TimeRanges", "in": "query", "schema": { "type": "string" } }, { "name": "TimeIncrement", "in": "query", "schema": { "type": "string" } }, { "name": "DatePreset", "in": "query", "schema": { "type": "string" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Summary", "in": "query", "schema": { "type": "string" } }, { "name": "UseAccountAttributionSetting", "in": "query", "schema": { "type": "boolean" } }, { "name": "UseUnifiedAttributionSetting", "in": "query", "schema": { "type": "boolean" } }, { "name": "After", "in": "query", "schema": { "type": "string" } }, { "name": "Before", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacebookGraphPassthroughResponseResponse" } } } } } } }, "/v1/facebook/adAccounts/{adAccountId}/campaigns": { "get": { "tags": [ "Facebook" ], "parameters": [ { "name": "adAccountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "Filtering", "in": "query", "schema": { "type": "string" } }, { "name": "EffectiveStatus", "in": "query", "schema": { "type": "string" } }, { "name": "After", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacebookGraphPassthroughResponseResponse" } } } } } } }, "/v1/facebook/adAccounts/{adAccountId}/adSets": { "get": { "tags": [ "Facebook" ], "parameters": [ { "name": "adAccountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "Filtering", "in": "query", "schema": { "type": "string" } }, { "name": "EffectiveStatus", "in": "query", "schema": { "type": "string" } }, { "name": "After", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacebookGraphPassthroughResponseResponse" } } } } } } }, "/v1/facebook/adAccounts/{adAccountId}/ads": { "get": { "tags": [ "Facebook" ], "parameters": [ { "name": "adAccountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "Filtering", "in": "query", "schema": { "type": "string" } }, { "name": "EffectiveStatus", "in": "query", "schema": { "type": "string" } }, { "name": "After", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacebookGraphPassthroughResponseResponse" } } } } } } }, "/v1/facebook/callback": { "get": { "tags": [ "FacebookCallback" ], "parameters": [ { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "error", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v1/googleAds/authorizeUrl": { "get": { "tags": [ "GoogleAds" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAdsAuthorizeUrlResponseResponse" } } } } } } }, "/v1/googleAds/status": { "get": { "tags": [ "GoogleAds" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAdsConnectionStatusResponseResponse" } } } } } } }, "/v1/googleAds/connection": { "delete": { "tags": [ "GoogleAds" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } } } } }, "/v1/googleAds/accounts": { "get": { "tags": [ "GoogleAds" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAdsReportPassthroughResponseResponse" } } } } } } }, "/v1/googleAds/accounts/{customerId}/performance": { "get": { "tags": [ "GoogleAds" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "string" } }, { "name": "end", "in": "query", "schema": { "type": "string" } }, { "name": "loginCustomerId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAdsReportPassthroughResponseResponse" } } } } } } }, "/v1/googleAds/accounts/{customerId}/campaigns": { "get": { "tags": [ "GoogleAds" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "string" } }, { "name": "end", "in": "query", "schema": { "type": "string" } }, { "name": "pageToken", "in": "query", "schema": { "type": "string" } }, { "name": "loginCustomerId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleAdsReportPassthroughResponseResponse" } } } } } } }, "/v1/googleAds/callback": { "get": { "tags": [ "GoogleAdsCallback" ], "parameters": [ { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "error", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/health": { "get": { "tags": [ "Health" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectResponse" } } } } } } }, "/v1/apiKeys/machine": { "post": { "tags": [ "MachineApiKeys" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineApiKeyCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MachineApiKeyCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MachineApiKeyCreateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineApiKeyCreateResponseResponse" } } } } } } }, "/v1/me": { "get": { "tags": [ "Me" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/media-assets/display": { "post": { "tags": [ "MediaAssets" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "DestinationUrl", "File", "Name" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Name": { "type": "string" }, "DestinationUrl": { "type": "string" }, "Width": { "type": "integer", "format": "int32" }, "Height": { "type": "integer", "format": "int32" } } }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" }, "DestinationUrl": { "style": "form" }, "Width": { "style": "form" }, "Height": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/media-assets/billboard": { "post": { "tags": [ "MediaAssets" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File", "Name" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Name": { "type": "string" }, "DestinationUrl": { "type": "string" } } }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" }, "DestinationUrl": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/media-assets/tv": { "post": { "tags": [ "MediaAssets" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File", "Name" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Name": { "type": "string" } } }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/media-assets/audio": { "post": { "tags": [ "MediaAssets" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File", "Name" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Name": { "type": "string" }, "ClickUrl": { "type": "string" } } }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" }, "ClickUrl": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/media-assets/native": { "post": { "tags": [ "MediaAssets" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Body", "CallToAction", "ClickUrl", "CompanyName", "File", "Headline", "Name" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "Name": { "type": "string" }, "Headline": { "type": "string" }, "Body": { "type": "string" }, "CompanyName": { "type": "string" }, "CallToAction": { "type": "string" }, "ClickUrl": { "type": "string" } } }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" }, "Headline": { "style": "form" }, "Body": { "style": "form" }, "CompanyName": { "style": "form" }, "CallToAction": { "style": "form" }, "ClickUrl": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/media-assets": { "get": { "tags": [ "MediaAssets" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetResponsePagedResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/media-assets/{mediaAssetId}": { "get": { "tags": [ "MediaAssets" ], "parameters": [ { "name": "mediaAssetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetResponseResponse" } } } } } }, "put": { "tags": [ "MediaAssets" ], "parameters": [ { "name": "mediaAssetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MediaAssetUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MediaAssetUpdateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetResponseResponse" } } } } } }, "delete": { "tags": [ "MediaAssets" ], "parameters": [ { "name": "mediaAssetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v1/advertisers/{advertiserId}/media-assets/{mediaAssetId}/ads": { "post": { "tags": [ "MediaAssets" ], "parameters": [ { "name": "mediaAssetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdFromMediaAssetCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AdFromMediaAssetCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AdFromMediaAssetCreateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/plans": { "post": { "tags": [ "Plans" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlanCreateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponseResponse" } } } } } }, "get": { "tags": [ "Plans" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponsePagedResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/plans/{planId}": { "get": { "tags": [ "Plans" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponseResponse" } } } } } }, "put": { "tags": [ "Plans" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PlanUpdateRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponseResponse" } } } } } }, "delete": { "tags": [ "Plans" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/plans/{planId}/executive-summary": { "get": { "tags": [ "Plans" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanExecutiveSummarySectionResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/plans/{planId}/market-analysis": { "get": { "tags": [ "Plans" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanMarketAnalysisSectionResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/plans/{planId}/personas": { "get": { "tags": [ "Plans" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanPersonasSectionResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/plans/{planId}/media-plan": { "get": { "tags": [ "Plans" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanMediaPlanSectionResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/plans/{planId}/projections": { "get": { "tags": [ "Plans" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanProjectionsSectionResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/plans/{planId}/reset": { "post": { "tags": [ "Plans" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/plans/{planId}/reset/{sectionName}": { "post": { "tags": [ "Plans" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sectionName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/reports/snapshot": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/reports/campaigns": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "start", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignsSummaryReportResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/reports/campaigns/{campaignId}": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignReportResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/reports/campaigns/{campaignId}/daily": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignReportResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/reports/campaigns/{campaignId}/dimensions/{dimension}": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dimension", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignDimensionReportResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/reports/campaigns/{campaignId}/ads": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdReportResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/reports/summary": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "start", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvertiserSummaryResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/reports/media-assets": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "start", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetReportListResponseResponse" } } } } } } }, "/v1/advertisers/{advertiserId}/reports/media-assets/{mediaAssetId}": { "get": { "tags": [ "Reports" ], "parameters": [ { "name": "mediaAssetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "end", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "advertiserId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetDetailedReportResponseResponse" } } } } } } }, "/v1/segments/internet": { "get": { "tags": [ "Segments" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentResponsePagedResponseResponse" } } } } } } }, "/v1/segments/tv": { "get": { "tags": [ "Segments" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentResponsePagedResponseResponse" } } } } } } }, "/v1/targeting/states": { "get": { "tags": [ "Targeting" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateResponsePagedResponseResponse" } } } } } } }, "/v1/targeting/cities": { "get": { "tags": [ "Targeting" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CityResponsePagedResponseResponse" } } } } } } }, "/v1/targeting/zipcodes": { "get": { "tags": [ "Targeting" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodeResponsePagedResponseResponse" } } } } } } }, "/v1/targeting/dmas": { "get": { "tags": [ "Targeting" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmaResponsePagedResponseResponse" } } } } } } } }, "components": { "schemas": { "AdDimensionsResponse": { "type": "object", "properties": { "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AdFromMediaAssetCreateRequest": { "required": [ "campaignId" ], "type": "object", "properties": { "campaignId": { "minLength": 1, "type": "string" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdMetricsResponse": { "type": "object", "properties": { "adId": { "type": "string", "nullable": true }, "adName": { "type": "string", "nullable": true }, "impressions": { "type": "integer", "format": "int64" }, "clicks": { "type": "integer", "format": "int64" }, "spend": { "type": "number", "format": "double" }, "ctr": { "type": "number", "format": "double", "nullable": true }, "cpc": { "type": "number", "format": "double", "nullable": true }, "cpm": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "AdReportResponse": { "type": "object", "properties": { "campaignId": { "type": "string", "nullable": true }, "dateRange": { "$ref": "#/components/schemas/DateRangeResponse" }, "ads": { "type": "array", "items": { "$ref": "#/components/schemas/AdMetricsResponse" }, "nullable": true } }, "additionalProperties": false }, "AdReportResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/AdReportResponse" } }, "additionalProperties": false }, "AdResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "adType": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "destinationUrl": { "type": "string", "nullable": true }, "adUrl": { "type": "string", "nullable": true }, "dimensions": { "$ref": "#/components/schemas/AdDimensionsResponse" }, "campaignId": { "type": "string", "nullable": true }, "mediaAssetId": { "type": "string", "nullable": true }, "headline": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "callToAction": { "type": "string", "nullable": true }, "audioDetails": { "$ref": "#/components/schemas/AudioDetailsResponse" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AdResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AdResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/AdResponsePagedResponse" } }, "additionalProperties": false }, "AdResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/AdResponse" } }, "additionalProperties": false }, "AdUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "destinationUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdvertiserCreateRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "website": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdvertiserPixelTagResponse": { "type": "object", "properties": { "pixelTag": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdvertiserPixelTagResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/AdvertiserPixelTagResponse" } }, "additionalProperties": false }, "AdvertiserResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AdvertiserResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdvertiserResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AdvertiserResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/AdvertiserResponsePagedResponse" } }, "additionalProperties": false }, "AdvertiserResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/AdvertiserResponse" } }, "additionalProperties": false }, "AdvertiserSummaryResponse": { "type": "object", "properties": { "dateRange": { "$ref": "#/components/schemas/DateRangeResponse" }, "totals": { "$ref": "#/components/schemas/MetricsSummaryResponse" }, "campaignCount": { "type": "integer", "format": "int32" }, "activeCampaignCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AdvertiserSummaryResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/AdvertiserSummaryResponse" } }, "additionalProperties": false }, "AdvertiserUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiKeyScope": { "enum": [ "Read", "Write", "Delete", "FullAccess" ], "type": "string" }, "ApiKeyScopeResponse": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiKeyScopesResponse": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyScopeResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ApiKeyScopesResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/ApiKeyScopesResponse" } }, "additionalProperties": false }, "AudienceType": { "enum": [ "Demographic", "Retargeting" ], "type": "string" }, "AudioDetailsResponse": { "type": "object", "properties": { "uploadedUrl": { "type": "string", "nullable": true }, "duration": { "type": "number", "format": "double" }, "fileSize": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "AudioSettingsResponse": { "type": "object", "additionalProperties": false }, "BidStrategyPresetListResponse": { "type": "object", "properties": { "presets": { "type": "array", "items": { "$ref": "#/components/schemas/BidStrategyPresetResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BidStrategyPresetListResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/BidStrategyPresetListResponse" } }, "additionalProperties": false }, "BidStrategyPresetResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "performanceRecommendation": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "displayOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BillboardSettingsResponse": { "type": "object", "additionalProperties": false }, "BlueprintCompetitiveLandscapeResponse": { "type": "object", "properties": { "competitiveAssessmentMethodology": { "type": "string", "nullable": true }, "keyCompetitorProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/BlueprintCompetitorProfileResponse" }, "nullable": true }, "marketPositioningAnalysis": { "type": "string", "nullable": true }, "shareOfVoiceAnalysis": { "type": "string", "nullable": true }, "gapAnalysis": { "type": "string", "nullable": true }, "competitivePositioningOpportunities": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintCompetitorProfileResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "strategicThreatLevel": { "type": "string", "nullable": true }, "overview": { "type": "string", "nullable": true }, "strengths": { "type": "string", "nullable": true }, "weaknesses": { "type": "string", "nullable": true }, "strategicImplications": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintCoreChallengesResponse": { "type": "object", "properties": { "coreChallengesInTheMarket": { "type": "array", "items": { "$ref": "#/components/schemas/BlueprintMarketChallengeResponse" }, "nullable": true }, "challengePrioritizationAnalysis": { "type": "string", "nullable": true }, "marketConstraintAnalysis": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintCreateRequest": { "type": "object", "properties": { "companyName": { "type": "string", "nullable": true }, "companyDomain": { "type": "string", "nullable": true }, "employees": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "integer", "format": "int32", "nullable": true }, "positioning": { "type": "string", "nullable": true }, "insights": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintGeographicClusterResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "clusterName": { "type": "string", "nullable": true }, "alignmentScore": { "type": "string", "nullable": true }, "priorityLevel": { "type": "string", "nullable": true }, "keyAreas": { "type": "string", "nullable": true }, "strategicRationale": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintGeographicOpportunitiesResponse": { "type": "object", "properties": { "geographicTargetingMethodology": { "type": "string", "nullable": true }, "regionalDemandAnalysis": { "type": "string", "nullable": true }, "opportunityScoringSystem": { "type": "array", "items": { "$ref": "#/components/schemas/BlueprintGeographicClusterResponse" }, "nullable": true }, "competitiveDensityAnalysis": { "type": "string", "nullable": true }, "demographicAnalysis": { "type": "string", "nullable": true }, "environmentalConsiderations": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintIndustryContextAnalysisResponse": { "type": "object", "properties": { "marketSizeAndGrowth": { "type": "string", "nullable": true }, "transformativeTrends": { "type": "string", "nullable": true }, "regulatoryConsiderations": { "type": "string", "nullable": true }, "seasonalImpacts": { "type": "string", "nullable": true }, "relatedIndustryInfluences": { "type": "string", "nullable": true }, "economicIndicators": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintInsightsSummaryResponse": { "type": "object", "properties": { "keyFindingsSynthesis": { "type": "string", "nullable": true }, "strategicDirection": { "type": "string", "nullable": true }, "businessSpecificStrategicInsights": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintMarketAnalysisResponse": { "type": "object", "properties": { "strategicOverview": { "$ref": "#/components/schemas/BlueprintStrategicOverviewResponse" }, "industryContextAnalysis": { "$ref": "#/components/schemas/BlueprintIndustryContextAnalysisResponse" }, "competitiveLandscape": { "$ref": "#/components/schemas/BlueprintCompetitiveLandscapeResponse" }, "geographicOpportunities": { "$ref": "#/components/schemas/BlueprintGeographicOpportunitiesResponse" }, "seasonalAndCyclicalPatterns": { "$ref": "#/components/schemas/BlueprintSeasonalPatternsResponse" }, "coreChallengesInMarket": { "$ref": "#/components/schemas/BlueprintCoreChallengesResponse" }, "insightsSummary": { "$ref": "#/components/schemas/BlueprintInsightsSummaryResponse" } }, "additionalProperties": false }, "BlueprintMarketChallengeResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "severity": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "operationalImplications": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintPersonaDemographicsResponse": { "type": "object", "properties": { "ageRange": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "incomeRange": { "type": "string", "nullable": true }, "education": { "type": "string", "nullable": true }, "occupation": { "type": "string", "nullable": true }, "lifestage": { "type": "string", "nullable": true }, "homeValue": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintPersonaResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "demographics": { "$ref": "#/components/schemas/BlueprintPersonaDemographicsResponse" }, "triggers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "barriers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "rank": { "type": "integer", "format": "int32" }, "prioritizationReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "companyDomain": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "marketAnalysis": { "$ref": "#/components/schemas/BlueprintMarketAnalysisResponse" }, "personas": { "type": "array", "items": { "$ref": "#/components/schemas/BlueprintPersonaResponse" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "BlueprintResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BlueprintResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BlueprintResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/BlueprintResponsePagedResponse" } }, "additionalProperties": false }, "BlueprintResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/BlueprintResponse" } }, "additionalProperties": false }, "BlueprintSeasonalPatternsResponse": { "type": "object", "properties": { "keySeasonalCycles": { "type": "string", "nullable": true }, "externalFactorAnalysis": { "type": "string", "nullable": true }, "demandVariationQuantification": { "type": "string", "nullable": true }, "consumerBehaviorTrends": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BlueprintStrategicOverviewResponse": { "type": "object", "properties": { "businessPositioning": { "type": "string", "nullable": true }, "coreMarketChallengesAndOpportunities": { "type": "string", "nullable": true }, "analyticalFramework": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CampaignActiveStatus": { "enum": [ "Active", "Inactive" ], "type": "string" }, "CampaignAudienceRequest": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AudienceType" }, "demographicAudience": { "$ref": "#/components/schemas/DemographicAudienceRequest" }, "retargetingAudience": { "$ref": "#/components/schemas/RetargetingAudienceRequest" } }, "additionalProperties": false }, "CampaignAudienceResponse": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AudienceType" }, "demographicAudience": { "$ref": "#/components/schemas/DemographicAudienceResponse" }, "retargetingAudience": { "$ref": "#/components/schemas/RetargetingAudienceResponse" } }, "additionalProperties": false }, "CampaignAudienceResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/CampaignAudienceResponse" } }, "additionalProperties": false }, "CampaignCreateRequest": { "required": [ "name" ], "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "name": { "minLength": 1, "type": "string" }, "budget": { "type": "number", "format": "double", "nullable": true }, "budgetFrequency": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "geo": { "$ref": "#/components/schemas/GeoRequest" }, "audience": { "$ref": "#/components/schemas/CampaignAudienceRequest" }, "settings": { "$ref": "#/components/schemas/CampaignSettingsRequest" }, "internetSettings": { "$ref": "#/components/schemas/InternetSettingsRequest" }, "contactEmail": { "type": "string", "nullable": true }, "isRetargeting": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CampaignDimensionReportResponse": { "type": "object", "properties": { "campaignId": { "type": "string", "nullable": true }, "dimension": { "type": "string", "nullable": true }, "dateRange": { "$ref": "#/components/schemas/DateRangeResponse" }, "breakdowns": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionBreakdownResponse" }, "nullable": true } }, "additionalProperties": false }, "CampaignDimensionReportResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/CampaignDimensionReportResponse" } }, "additionalProperties": false }, "CampaignLaunchRequest": { "type": "object", "properties": { "totalIntervals": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CampaignReportResponse": { "type": "object", "properties": { "campaignId": { "type": "string", "nullable": true }, "campaignName": { "type": "string", "nullable": true }, "campaignType": { "type": "string", "nullable": true }, "dateRange": { "$ref": "#/components/schemas/DateRangeResponse" }, "totals": { "$ref": "#/components/schemas/MetricsSummaryResponse" }, "timeSeries": { "type": "array", "items": { "$ref": "#/components/schemas/TimeSeriesPointResponse" }, "nullable": true } }, "additionalProperties": false }, "CampaignReportResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/CampaignReportResponse" } }, "additionalProperties": false }, "CampaignReportSummaryResponse": { "type": "object", "properties": { "campaignId": { "type": "string", "nullable": true }, "campaignName": { "type": "string", "nullable": true }, "campaignType": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "totals": { "$ref": "#/components/schemas/MetricsSummaryResponse" } }, "additionalProperties": false }, "CampaignReportSummaryResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignReportSummaryResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CampaignResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "campaignType": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "budget": { "type": "number", "format": "double" }, "budgetFrequency": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "geo": { "$ref": "#/components/schemas/GeoResponse" }, "audience": { "$ref": "#/components/schemas/CampaignAudienceResponse" }, "settings": { "$ref": "#/components/schemas/CampaignSettingsResponse" }, "internetSettings": { "$ref": "#/components/schemas/InternetSettingsResponse" }, "tvSettings": { "$ref": "#/components/schemas/TvSettingsResponse" }, "billboardSettings": { "$ref": "#/components/schemas/BillboardSettingsResponse" }, "audioSettings": { "$ref": "#/components/schemas/AudioSettingsResponse" }, "adIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "totalIntervals": { "type": "integer", "format": "int32", "nullable": true }, "intervalsCompleted": { "type": "integer", "format": "int32", "nullable": true }, "activatedDate": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CampaignResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CampaignResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/CampaignResponsePagedResponse" } }, "additionalProperties": false }, "CampaignResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/CampaignResponse" } }, "additionalProperties": false }, "CampaignSettingsRequest": { "type": "object", "properties": { "dayparting": { "$ref": "#/components/schemas/DaypartingRequest" }, "frequencyCap": { "$ref": "#/components/schemas/FrequencyCapRequest" } }, "additionalProperties": false }, "CampaignSettingsResponse": { "type": "object", "properties": { "dayparting": { "$ref": "#/components/schemas/DaypartingResponse" }, "frequencyCap": { "$ref": "#/components/schemas/FrequencyCapResponse" } }, "additionalProperties": false }, "CampaignSettingsResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/CampaignSettingsResponse" } }, "additionalProperties": false }, "CampaignStatus": { "enum": [ "NoApprovedAds", "EndingOn", "PaymentRetrying", "PaymentFailed", "SavedForLater", "CampaignEnded", "PendingAdApproval", "Archived", "Scheduled", "PendingNetworkApproval", "Live", "Deleted", "WaitingForTVOutro", "WaitingForCustomAds" ], "type": "string" }, "CampaignUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "budget": { "type": "number", "format": "double", "nullable": true }, "budgetFrequency": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "geo": { "$ref": "#/components/schemas/GeoRequest" }, "audience": { "$ref": "#/components/schemas/CampaignAudienceRequest" }, "settings": { "$ref": "#/components/schemas/CampaignSettingsRequest" }, "internetSettings": { "$ref": "#/components/schemas/InternetSettingsRequest" }, "contactEmail": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CampaignsSummaryReportResponse": { "type": "object", "properties": { "start": { "type": "string", "format": "date" }, "end": { "type": "string", "format": "date" }, "campaigns": { "$ref": "#/components/schemas/CampaignReportSummaryResponsePagedResponse" } }, "additionalProperties": false }, "CampaignsSummaryReportResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/CampaignsSummaryReportResponse" } }, "additionalProperties": false }, "CanvaAuthorizeUrlResponse": { "type": "object", "properties": { "authorizeUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CanvaAuthorizeUrlResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/CanvaAuthorizeUrlResponse" } }, "additionalProperties": false }, "CanvaConnectionStatusResponse": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "tokenExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "scopes": { "type": "string", "nullable": true }, "canvaUserId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CanvaConnectionStatusResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/CanvaConnectionStatusResponse" } }, "additionalProperties": false }, "CanvaPagingResponse": { "type": "object", "properties": { "continuation": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CanvaPassthroughResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JsonNode" }, "paging": { "$ref": "#/components/schemas/CanvaPagingResponse" } }, "additionalProperties": false }, "CanvaPassthroughResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/CanvaPassthroughResponse" } }, "additionalProperties": false }, "CityGeoRequest": { "required": [ "name", "stateCode" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "stateCode": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CityGeoResponse": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "stateCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CityResponse": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "stateCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CityResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CityResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CityResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/CityResponsePagedResponse" } }, "additionalProperties": false }, "DateRangeResponse": { "type": "object", "properties": { "start": { "type": "string", "format": "date" }, "end": { "type": "string", "format": "date" } }, "additionalProperties": false }, "DaypartingRequest": { "type": "object", "properties": { "sunday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "monday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "tuesday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "wednesday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "thursday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "friday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "saturday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "DaypartingResponse": { "type": "object", "properties": { "sunday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "monday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "tuesday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "wednesday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "thursday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "friday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "saturday": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "DemographicAudienceRequest": { "type": "object", "properties": { "segments": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true } }, "additionalProperties": false }, "DemographicAudienceResponse": { "type": "object", "properties": { "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentResponse" }, "nullable": true } }, "additionalProperties": false }, "DimensionBreakdownResponse": { "type": "object", "properties": { "dimensionValue": { "type": "string", "nullable": true }, "impressions": { "type": "integer", "format": "int64" }, "clicks": { "type": "integer", "format": "int64" }, "spend": { "type": "number", "format": "double" }, "ctr": { "type": "number", "format": "double", "nullable": true }, "cpc": { "type": "number", "format": "double", "nullable": true }, "cpm": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "DmaResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DmaResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DmaResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DmaResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/DmaResponsePagedResponse" } }, "additionalProperties": false }, "DomainResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "domain": { "type": "string", "nullable": true }, "subDomains": { "type": "array", "items": { "type": "string" }, "nullable": true }, "maxHeight": { "type": "integer", "format": "int32", "nullable": true }, "maxWidth": { "type": "integer", "format": "int32", "nullable": true }, "isSquare": { "type": "boolean" }, "logoUrl": { "type": "string", "nullable": true }, "networkType": { "$ref": "#/components/schemas/NetworkType" } }, "additionalProperties": false }, "DomainResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DomainResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DomainResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/DomainResponsePagedResponse" } }, "additionalProperties": false }, "Error": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExecutiveSummarySectionResponse": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true }, "showTitle": { "type": "boolean" } }, "additionalProperties": false }, "FacebookAuthorizeUrlResponse": { "type": "object", "properties": { "authorizeUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FacebookAuthorizeUrlResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/FacebookAuthorizeUrlResponse" } }, "additionalProperties": false }, "FacebookConnectionStatusResponse": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "tokenExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "scopes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FacebookConnectionStatusResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/FacebookConnectionStatusResponse" } }, "additionalProperties": false }, "FacebookGraphPassthroughResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JsonNode" }, "paging": { "$ref": "#/components/schemas/FacebookPagingResponse" } }, "additionalProperties": false }, "FacebookGraphPassthroughResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/FacebookGraphPassthroughResponse" } }, "additionalProperties": false }, "FacebookPagingResponse": { "type": "object", "properties": { "pageSize": { "type": "integer", "format": "int32" }, "nextCursor": { "type": "string", "nullable": true }, "previousCursor": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FrequencyCapRequest": { "type": "object", "properties": { "maxImpressions": { "type": "integer", "format": "int32" }, "period": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FrequencyCapResponse": { "type": "object", "properties": { "maxImpressions": { "type": "integer", "format": "int32" }, "period": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GeoRequest": { "type": "object", "properties": { "states": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cities": { "type": "array", "items": { "$ref": "#/components/schemas/CityGeoRequest" }, "nullable": true }, "zips": { "type": "array", "items": { "$ref": "#/components/schemas/ZipGeoRequest" }, "nullable": true }, "dmas": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true } }, "additionalProperties": false }, "GeoResponse": { "type": "object", "properties": { "locationTargetType": { "type": "string", "nullable": true }, "states": { "type": "array", "items": { "type": "string" }, "nullable": true }, "cities": { "type": "array", "items": { "$ref": "#/components/schemas/CityGeoResponse" }, "nullable": true }, "zips": { "type": "array", "items": { "$ref": "#/components/schemas/ZipGeoResponse" }, "nullable": true }, "dmas": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true } }, "additionalProperties": false }, "GeoResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/GeoResponse" } }, "additionalProperties": false }, "GoogleAdsAuthorizeUrlResponse": { "type": "object", "properties": { "authorizeUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GoogleAdsAuthorizeUrlResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/GoogleAdsAuthorizeUrlResponse" } }, "additionalProperties": false }, "GoogleAdsConnectionStatusResponse": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "tokenExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "scopes": { "type": "string", "nullable": true }, "loginCustomerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GoogleAdsConnectionStatusResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/GoogleAdsConnectionStatusResponse" } }, "additionalProperties": false }, "GoogleAdsReportPassthroughResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JsonNode" }, "nextPageToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GoogleAdsReportPassthroughResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/GoogleAdsReportPassthroughResponse" } }, "additionalProperties": false }, "InternetSettingsRequest": { "type": "object", "properties": { "bidStrategyPresetId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InternetSettingsResponse": { "type": "object", "properties": { "bidStrategyPresetId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JsonNode": { "type": "object", "properties": { "options": { "$ref": "#/components/schemas/JsonNodeOptions" }, "parent": { "$ref": "#/components/schemas/JsonNode" }, "root": { "$ref": "#/components/schemas/JsonNode" } }, "additionalProperties": false }, "JsonNodeOptions": { "type": "object", "properties": { "propertyNameCaseInsensitive": { "type": "boolean" } }, "additionalProperties": false }, "MachineApiKeyCreateRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "scopes": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyScope" }, "nullable": true } }, "additionalProperties": false }, "MachineApiKeyCreateResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "key": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "keyPrefix": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "MachineApiKeyCreateResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/MachineApiKeyCreateResponse" } }, "additionalProperties": false }, "MeOrganizationResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MeResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/MeUserResponse" }, "organization": { "$ref": "#/components/schemas/MeOrganizationResponse" } }, "additionalProperties": false }, "MeResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/MeResponse" } }, "additionalProperties": false }, "MeUserResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MediaAssetAdMetricsResponse": { "type": "object", "properties": { "adId": { "type": "string", "nullable": true }, "adName": { "type": "string", "nullable": true }, "campaignId": { "type": "string", "nullable": true }, "campaignName": { "type": "string", "nullable": true }, "impressions": { "type": "integer", "format": "int64" }, "clicks": { "type": "integer", "format": "int64" }, "spend": { "type": "number", "format": "double" }, "ctr": { "type": "number", "format": "double", "nullable": true }, "cpc": { "type": "number", "format": "double", "nullable": true }, "cpm": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MediaAssetDetailedReportResponse": { "type": "object", "properties": { "mediaAssetId": { "type": "string", "nullable": true }, "mediaAssetName": { "type": "string", "nullable": true }, "assetType": { "type": "string", "nullable": true }, "impressions": { "type": "integer", "format": "int64" }, "clicks": { "type": "integer", "format": "int64" }, "spend": { "type": "number", "format": "double" }, "ctr": { "type": "number", "format": "double", "nullable": true }, "cpc": { "type": "number", "format": "double", "nullable": true }, "cpm": { "type": "number", "format": "double", "nullable": true }, "dateRange": { "$ref": "#/components/schemas/DateRangeResponse" }, "ads": { "type": "array", "items": { "$ref": "#/components/schemas/MediaAssetAdMetricsResponse" }, "nullable": true }, "daily": { "type": "array", "items": { "$ref": "#/components/schemas/TimeSeriesPointResponse" }, "nullable": true } }, "additionalProperties": false }, "MediaAssetDetailedReportResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/MediaAssetDetailedReportResponse" } }, "additionalProperties": false }, "MediaAssetDimensionsResponse": { "type": "object", "properties": { "width": { "type": "integer", "format": "int32" }, "height": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MediaAssetMetricsResponse": { "type": "object", "properties": { "mediaAssetId": { "type": "string", "nullable": true }, "mediaAssetName": { "type": "string", "nullable": true }, "assetType": { "type": "string", "nullable": true }, "adCount": { "type": "integer", "format": "int32" }, "impressions": { "type": "integer", "format": "int64" }, "clicks": { "type": "integer", "format": "int64" }, "spend": { "type": "number", "format": "double" }, "ctr": { "type": "number", "format": "double", "nullable": true }, "cpc": { "type": "number", "format": "double", "nullable": true }, "cpm": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "MediaAssetNativeDetailsResponse": { "type": "object", "properties": { "headline": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "callToAction": { "type": "string", "nullable": true }, "clickUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MediaAssetReportListResponse": { "type": "object", "properties": { "dateRange": { "$ref": "#/components/schemas/DateRangeResponse" }, "mediaAssets": { "type": "array", "items": { "$ref": "#/components/schemas/MediaAssetMetricsResponse" }, "nullable": true } }, "additionalProperties": false }, "MediaAssetReportListResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/MediaAssetReportListResponse" } }, "additionalProperties": false }, "MediaAssetResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "assetType": { "type": "string", "nullable": true }, "assetUrl": { "type": "string", "nullable": true }, "destinationUrl": { "type": "string", "nullable": true }, "dimensions": { "$ref": "#/components/schemas/MediaAssetDimensionsResponse" }, "videoUrl": { "type": "string", "nullable": true }, "nativeDetails": { "$ref": "#/components/schemas/MediaAssetNativeDetailsResponse" }, "audioDetails": { "$ref": "#/components/schemas/AudioDetailsResponse" }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "MediaAssetResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MediaAssetResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MediaAssetResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/MediaAssetResponsePagedResponse" } }, "additionalProperties": false }, "MediaAssetResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/MediaAssetResponse" } }, "additionalProperties": false }, "MediaAssetUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "destinationUrl": { "type": "string", "nullable": true }, "headline": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "callToAction": { "type": "string", "nullable": true }, "clickUrl": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "MetricsSummaryResponse": { "type": "object", "properties": { "impressions": { "type": "integer", "format": "int64" }, "clicks": { "type": "integer", "format": "int64" }, "spend": { "type": "number", "format": "double" }, "uniqueViewers": { "type": "integer", "format": "int64" }, "ctr": { "type": "number", "format": "double", "nullable": true }, "cpc": { "type": "number", "format": "double", "nullable": true }, "cpm": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "NetworkType": { "enum": [ "NotSet", "Information", "Sports", "Entertainment", "Lifestyle", "News", "Business", "Shopping", "Miscellaneous", "General" ], "type": "string" }, "ObjectResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "nullable": true } }, "additionalProperties": false }, "PlanBudgetResponse": { "type": "object", "properties": { "monthly": { "type": "number", "format": "double" }, "aiRecommendedMin": { "type": "number", "format": "double" }, "aiRecommendedTarget": { "type": "number", "format": "double" }, "aiRecommendedMax": { "type": "number", "format": "double" } }, "additionalProperties": false }, "PlanCampaignBuilderResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "isOffAdCritter": { "type": "boolean" }, "budget": { "type": "number", "format": "double" }, "summary": { "type": "string", "nullable": true }, "detailedSummary": { "type": "string", "nullable": true }, "audienceSummary": { "type": "string", "nullable": true }, "geoSummary": { "type": "string", "nullable": true }, "seasonalitySummary": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "PlanChannelsRequest": { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" }, "nullable": true }, "exclude": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PlanCreateRequest": { "type": "object", "properties": { "blueprintId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "monthlyBudget": { "type": "number", "format": "double", "nullable": true }, "channels": { "$ref": "#/components/schemas/PlanChannelsRequest" }, "personas": { "type": "array", "items": { "type": "string" }, "nullable": true }, "durationInMonths": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "insights": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PlanDurationResponse": { "type": "object", "properties": { "months": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "PlanExecutiveSummarySectionResponse": { "type": "object", "properties": { "pageTitle": { "type": "string", "nullable": true }, "sections": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutiveSummarySectionResponse" }, "nullable": true } }, "additionalProperties": false }, "PlanExecutiveSummarySectionResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/PlanExecutiveSummarySectionResponse" } }, "additionalProperties": false }, "PlanMarketAnalysisSectionResponse": { "type": "object", "properties": { "marketAnalysis": { "$ref": "#/components/schemas/BlueprintMarketAnalysisResponse" }, "sectionTitles": { "$ref": "#/components/schemas/PlanMarketAnalysisSectionTitlesResponse" } }, "additionalProperties": false }, "PlanMarketAnalysisSectionResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/PlanMarketAnalysisSectionResponse" } }, "additionalProperties": false }, "PlanMarketAnalysisSectionTitlesResponse": { "type": "object", "properties": { "strategicOverviewTitle": { "type": "string", "nullable": true }, "industryContextAnalysisTitle": { "type": "string", "nullable": true }, "competitiveLandscapeTitle": { "type": "string", "nullable": true }, "geographicOpportunitiesTitle": { "type": "string", "nullable": true }, "seasonalPatternsTitle": { "type": "string", "nullable": true }, "coreChallengesTitle": { "type": "string", "nullable": true }, "insightsSummaryTitle": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PlanMediaPlanSectionResponse": { "type": "object", "properties": { "pageTitle": { "type": "string", "nullable": true }, "budget": { "type": "string", "nullable": true }, "campaignDetailsTitle": { "type": "string", "nullable": true }, "campaignBuilders": { "type": "array", "items": { "$ref": "#/components/schemas/PlanCampaignBuilderResponse" }, "nullable": true } }, "additionalProperties": false }, "PlanMediaPlanSectionResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/PlanMediaPlanSectionResponse" } }, "additionalProperties": false }, "PlanPersonasSectionResponse": { "type": "object", "properties": { "pageTitle": { "type": "string", "nullable": true }, "introduction": { "type": "string", "nullable": true }, "personas": { "type": "array", "items": { "$ref": "#/components/schemas/BlueprintPersonaResponse" }, "nullable": true } }, "additionalProperties": false }, "PlanPersonasSectionResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/PlanPersonasSectionResponse" } }, "additionalProperties": false }, "PlanProjectionsSectionResponse": { "type": "object", "properties": { "pageTitle": { "type": "string", "nullable": true }, "whereAdsAppearTitle": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PlanProjectionsSectionResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/PlanProjectionsSectionResponse" } }, "additionalProperties": false }, "PlanResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "blueprintId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "budget": { "$ref": "#/components/schemas/PlanBudgetResponse" }, "duration": { "$ref": "#/components/schemas/PlanDurationResponse" }, "sections": { "$ref": "#/components/schemas/PlanSectionsResponse" }, "personas": { "type": "array", "items": { "$ref": "#/components/schemas/BlueprintPersonaResponse" }, "nullable": true }, "marketAnalysis": { "$ref": "#/components/schemas/BlueprintMarketAnalysisResponse" }, "campaignBuilders": { "type": "array", "items": { "$ref": "#/components/schemas/PlanCampaignBuilderResponse" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "PlanResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PlanResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PlanResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/PlanResponsePagedResponse" } }, "additionalProperties": false }, "PlanResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/PlanResponse" } }, "additionalProperties": false }, "PlanSectionsResponse": { "type": "object", "properties": { "planSummary": { "type": "string", "nullable": true }, "planDetails": { "type": "string", "nullable": true }, "audienceSummary": { "type": "string", "nullable": true }, "audienceDetails": { "type": "string", "nullable": true }, "geoSummary": { "type": "string", "nullable": true }, "geoDetails": { "type": "string", "nullable": true }, "seasonalitySummary": { "type": "string", "nullable": true }, "seasonalityDetails": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PlanUpdateRequest": { "type": "object", "properties": { "planSummary": { "type": "string", "nullable": true }, "planDetails": { "type": "string", "nullable": true }, "audienceSummary": { "type": "string", "nullable": true }, "audienceDetails": { "type": "string", "nullable": true }, "geoSummary": { "type": "string", "nullable": true }, "geoDetails": { "type": "string", "nullable": true }, "seasonalitySummary": { "type": "string", "nullable": true }, "seasonalityDetails": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RetargetingAudienceRequest": { "type": "object", "properties": { "retargetingType": { "type": "string", "nullable": true }, "retargetingCampaignIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "urlParts": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RetargetingAudienceResponse": { "type": "object", "properties": { "retargetingType": { "type": "string", "nullable": true }, "retargetingCampaignIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "urlParts": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SegmentResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SegmentResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SegmentResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/SegmentResponsePagedResponse" } }, "additionalProperties": false }, "SnapshotCampaignResponse": { "type": "object", "properties": { "campaignId": { "type": "string", "nullable": true }, "campaignName": { "type": "string", "nullable": true }, "campaignType": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "pacing": { "type": "number", "format": "double", "nullable": true }, "todaySpend": { "type": "number", "format": "double" }, "intervalBudget": { "type": "number", "format": "double" }, "averageSpendPerDay": { "type": "number", "format": "double" }, "intervalStartDate": { "type": "string", "format": "date-time" }, "intervalEndDate": { "type": "string", "format": "date-time" }, "intervalCpm": { "type": "number", "format": "double", "nullable": true }, "intervalTotalClicks": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SnapshotResponse": { "type": "object", "properties": { "campaigns": { "type": "array", "items": { "$ref": "#/components/schemas/SnapshotCampaignResponse" }, "nullable": true } }, "additionalProperties": false }, "SnapshotResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/SnapshotResponse" } }, "additionalProperties": false }, "StateResponse": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StateResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/StateResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "StateResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/StateResponsePagedResponse" } }, "additionalProperties": false }, "TimeSeriesPointResponse": { "type": "object", "properties": { "date": { "type": "string", "nullable": true }, "impressions": { "type": "integer", "format": "int64" }, "clicks": { "type": "integer", "format": "int64" }, "spend": { "type": "number", "format": "double" }, "uniqueViewers": { "type": "integer", "format": "int64" }, "ctr": { "type": "number", "format": "double", "nullable": true }, "cpc": { "type": "number", "format": "double", "nullable": true }, "cpm": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "TvSettingsResponse": { "type": "object", "additionalProperties": false }, "ZipCodeResponse": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ZipCodeResponsePagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ZipCodeResponse" }, "nullable": true }, "total": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ZipCodeResponsePagedResponseResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "nullable": true }, "data": { "$ref": "#/components/schemas/ZipCodeResponsePagedResponse" } }, "additionalProperties": false }, "ZipGeoRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "ZipGeoResponse": { "type": "object", "properties": { "code": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "description": "API key authentication. Prefix: ac_live_", "name": "X-Api-Key", "in": "header" }, "Bearer": { "type": "http", "description": "JWT Bearer token authentication via Auth0.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "ApiKey": [ ], "Bearer": [ ] } ] }