openapi: 3.1.0 info: title: Ads Manager API description: Ads Manager API version: 1.0.0 paths: /accounts: get: tags: - Accounts summary: Get Accounts description: Gets accounts in an organization operationId: get_accounts security: - api-key: [] - user-id: [] - session: [] parameters: - name: limit in: query required: false schema: type: integer maximum: 100 exclusiveMinimum: 1 description: Number of accounts to limit response to default: 10 title: Limit description: Number of accounts to limit response to - name: page_num in: query required: false schema: type: integer minimum: 1 description: Page number to retrieve. Starts at 1. default: 1 title: Page Num description: Page number to retrieve. Starts at 1. - name: sort_order in: query required: false schema: $ref: '#/components/schemas/SortOrder' description: Sorts accounts by name default: asc description: Sorts accounts by name - name: updated_since in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limits results to accounts updated since a unix timestamp title: Updated Since description: Limits results to accounts updated since a unix timestamp - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: organization_id in: query required: true schema: type: integer title: Organization Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccountsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error post: tags: - Accounts summary: Create Account description: Creates an account operationId: create_account security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: organization_id in: query required: true schema: type: integer title: Organization Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAccountModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccountModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /accounts/{account_id}: get: tags: - Accounts summary: Get Account description: Gets an account operationId: get_account security: - api-key: [] - user-id: [] - session: [] parameters: - name: account_id in: path required: true schema: type: integer title: Account Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccountModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error put: tags: - Accounts summary: Update Account description: Updates an account operationId: update_account security: - api-key: [] - user-id: [] - session: [] parameters: - name: account_id in: path required: true schema: type: integer title: Account Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAccountModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccountModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error delete: tags: - Accounts summary: Delete Account description: Deletes an account operationId: delete_account security: - api-key: [] - user-id: [] - session: [] parameters: - name: account_id in: path required: true schema: type: integer title: Account Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: organization_id in: query required: true schema: type: integer title: Organization Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /accounts/{account_id}/min_cpv_bid_rate: get: tags: - Accounts summary: Get Account Min Cpv Bid Rate description: Gets the minimum CPV bid rate for an account operationId: get_account_min_cpv_bid_rate security: - api-key: [] - user-id: [] - session: [] parameters: - name: account_id in: path required: true schema: type: integer title: Account Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccountMinCPVBidRateModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /accounts/{account_id}/pixels: get: tags: - Accounts summary: Get Account Pixels description: Gets pixels for an account operationId: get_account_pixels security: - api-key: [] - user-id: [] - session: [] parameters: - name: account_id in: path required: true schema: type: integer title: Account Id - name: limit in: query required: false schema: type: integer maximum: 100 exclusiveMinimum: 1 description: Number of account pixels to limit response to default: 10 title: Limit description: Number of account pixels to limit response to - name: page_num in: query required: false schema: type: integer minimum: 1 description: Page number to retrieve. Starts at 1. default: 1 title: Page Num description: Page number to retrieve. Starts at 1. - name: sort_order in: query required: false schema: $ref: '#/components/schemas/SortOrder' description: Sorts account pixels by name default: asc description: Sorts account pixels by name - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccountPixelsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error post: tags: - Accounts summary: Create Account Pixel description: Creates an account pixel operationId: create_account_pixel security: - api-key: [] - user-id: [] - session: [] parameters: - name: account_id in: path required: true schema: type: integer title: Account Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAccountPixelModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccountPixelModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /accounts/{account_id}/pixels/export: get: tags: - Accounts summary: Get Account Pixels Export description: Downloads a spreadsheet with account pixel information operationId: get_account_pixels_export security: - api-key: [] - user-id: [] - session: [] parameters: - name: account_id in: path required: true schema: type: integer title: Account Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: {} '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /accounts/{account_id}/pixels/{pixel_id}: delete: tags: - Accounts summary: Delete Account Pixel description: Deletes an account pixel operationId: delete_account_pixel security: - api-key: [] - user-id: [] - session: [] parameters: - name: pixel_id in: path required: true schema: type: integer title: Pixel Id - name: account_id in: path required: true schema: type: integer title: Account Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /adgroups: post: tags: - Ad Groups summary: Create Adgroup description: Creates an ad group operationId: create_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: campaign_id in: query required: true schema: type: integer title: Campaign Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAdgroupModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AdgroupModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error get: tags: - Ad Groups summary: Get Adgroups description: Gets all ad groups in a campaign operationId: get_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: limit in: query required: false schema: type: integer maximum: 100 exclusiveMinimum: 1 description: Number of ad groups to limit response to default: 10 title: Limit description: Number of ad groups to limit response to - name: page_num in: query required: false schema: type: integer minimum: 1 description: Page number to retrieve. Starts at 1. default: 1 title: Page Num description: Page number to retrieve. Starts at 1. - name: sort_order in: query required: false schema: $ref: '#/components/schemas/SortOrder' description: Sorts ad groups by name default: asc description: Sorts ad groups by name - name: updated_since in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limits results to ad adgroups updated since a unix timestamp title: Updated Since description: Limits results to ad adgroups updated since a unix timestamp - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: campaign_id in: query required: true schema: type: integer title: Campaign Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AdgroupsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /adgroups/dooh: post: tags: - Ad Groups summary: Create Dooh Adgroups description: Creates dooh ad groups with plan data operationId: create_dooh_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: campaign_id in: query required: true schema: type: integer title: Campaign Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDoohAdgroupsModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DOOHAdgroupIDsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /adgroups/{adgroup_id}: put: tags: - Ad Groups summary: Update Adgroup description: Updates an ad group operationId: update_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAdgroupModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AdgroupModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error patch: tags: - Ad Groups summary: Patch Adgroup description: Patches an ad group operationId: patch_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchAdgroupModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AdgroupModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error delete: tags: - Ad Groups summary: Delete Adgroup description: Deletes an ad group operationId: delete_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error get: tags: - Ad Groups summary: Get Adgroup description: Gets an ad group operationId: get_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AdgroupModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /adgroups/{adgroup_id}/avails: get: tags: - Ad Groups summary: Get Adgroup Avails description: Gets avails for an ad group operationId: get_adgroup_avails security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AdgroupAvailsResponse' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /adgroups/{adgroup_id}/location_filters/download: get: tags: - Ad Groups summary: Download Location Filters description: Downloads location filters for an ad group operationId: download_location_filters security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: {} '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /adgroups/{adgroup_id}/clone: post: tags: - Ad Groups summary: Clone Adgroup description: Clones an ad group once per requested media type with the given objective operationId: clone_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CloneAdgroupRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ClonedAdgroupsResponse' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /audiences/audience_taxonomy: get: tags: - Audiences summary: Get Audience Taxonomy description: Gets entire audience taxonomy for a tenant and account operationId: get_audience_taxonomy security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AudienceTaxonomy' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /audiences/recommendations: post: tags: - Audiences summary: Get Audience Recommendations description: Gets audience recommendations based on current selections operationId: get_audience_recommendations security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AudienceRecommendationsRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AudienceRecommendationsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /campaigns: get: tags: - Campaigns summary: Get Campaigns description: Gets all campaigns in an account operationId: get_campaigns security: - api-key: [] - user-id: [] - session: [] parameters: - name: limit in: query required: false schema: type: integer maximum: 100 exclusiveMinimum: 1 description: Number of campaigns to limit response to default: 10 title: Limit description: Number of campaigns to limit response to - name: page_num in: query required: false schema: type: integer minimum: 1 description: Page number to retrieve. Starts at 1. default: 1 title: Page Num description: Page number to retrieve. Starts at 1. - name: sort_order in: query required: false schema: $ref: '#/components/schemas/SortOrder' description: Sorts campaigns by name default: asc description: Sorts campaigns by name - name: updated_since in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limits results to campaigns updated since a unix timestamp title: Updated Since description: Limits results to campaigns updated since a unix timestamp - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CampaignsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error post: tags: - Campaigns summary: Create Campaign description: Creates a campaign operationId: create_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCampaignModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CampaignModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /campaigns/with_adgroups: post: tags: - Campaigns summary: Create Campaign And Adgroups description: Creates a campaign and ad groups together operationId: create_campaign_and_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCampaignAndAdgroupsModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CampaignAndAdgroupsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /campaigns/dashboard: get: tags: - Campaigns summary: Get Campaigns Dashboard description: Gets campaigns in a tenant operationId: get_campaigns_dashboard security: - api-key: [] - user-id: [] - session: [] parameters: - name: limit in: query required: false schema: type: integer maximum: 100 exclusiveMinimum: 1 description: Number of campaigns to limit response to default: 10 title: Limit description: Number of campaigns to limit response to - name: page_num in: query required: false schema: type: integer minimum: 1 description: Page number to retrieve. Starts at 1. default: 1 title: Page Num description: Page number to retrieve. Starts at 1. - name: sort_by in: query required: false schema: $ref: '#/components/schemas/CampaignDashboardSortField' description: Field to sort campaigns by (non-reporting columns only) default: name description: Field to sort campaigns by (non-reporting columns only) - name: sort_order in: query required: false schema: $ref: '#/components/schemas/SortOrder' description: Sort order default: asc description: Sort order - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Include campaigns that overlap this range start (end_date >= start_date or open-ended). Also used as reporting metrics start date (YYYY-MM-DD). title: Start Date description: Include campaigns that overlap this range start (end_date >= start_date or open-ended). Also used as reporting metrics start date (YYYY-MM-DD). - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Include campaigns that overlap this range end (start_date <= end_date). Also used as reporting metrics end date (YYYY-MM-DD). title: End Date description: Include campaigns that overlap this range end (start_date <= end_date). Also used as reporting metrics end date (YYYY-MM-DD). - name: status in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/CampaignDashboardStatus' - type: 'null' description: Filter by campaign statuses title: Status description: Filter by campaign statuses - name: account_ids in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' description: Filter by account ID(s) title: Account Ids description: Filter by account ID(s) - name: organization_ids in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' description: Filter by organization ID(s) title: Organization Ids description: Filter by organization ID(s) - name: objectives in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/Objective' - type: 'null' description: Filter by ad group objectives. Returns campaigns with at least one matching ad group. title: Objectives description: Filter by ad group objectives. Returns campaigns with at least one matching ad group. - name: search in: query required: false schema: anyOf: - type: string - type: 'null' description: Search by campaign name or ID title: Search description: Search by campaign name or ID - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CampaignsDashboardModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /campaigns/dashboard/export: post: tags: - Campaigns summary: Export Campaigns Dashboard description: Exports campaigns in a tenant as an Excel file operationId: export_campaigns_dashboard security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportCampaignsDashboardRequestModel' responses: '200': description: Successful Response content: application/json: schema: {} '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /campaigns/{campaign_id}: get: tags: - Campaigns summary: Get Campaign description: Gets a campaign operationId: get_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CampaignModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error put: tags: - Campaigns summary: Update Campaign description: Updates a campaign operationId: update_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateCampaignModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CampaignModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error delete: tags: - Campaigns summary: Delete Campaign description: Deletes a campaign operationId: delete_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /campaigns/{campaign_id}/ad_packages: post: tags: - Campaigns summary: Create Ad Package description: Creates an ad package operationId: create_ad_package security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAdPackageModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreatedAdPackageModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /creative_assets: get: tags: - Creative Assets summary: Get Creative Assets description: Gets creative assets in a tenant operationId: get_creative_assets security: - api-key: [] - user-id: [] - session: [] parameters: - name: limit in: query required: false schema: type: integer maximum: 100 exclusiveMinimum: 1 description: Number of creative assets to limit response to default: 10 title: Limit description: Number of creative assets to limit response to - name: page_num in: query required: false schema: type: integer minimum: 1 description: Page number to retrieve. Starts at 1. default: 1 title: Page Num description: Page number to retrieve. Starts at 1. - name: sort_by in: query required: false schema: $ref: '#/components/schemas/CreativeAssetSortField' description: Field to sort creative assets by default: created_date description: Field to sort creative assets by - name: sort_order in: query required: false schema: $ref: '#/components/schemas/SortOrder' description: Sort order for creative assets default: desc description: Sort order for creative assets - name: updated_date_from in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Filter to creative assets updated on or after this date title: Updated Date From description: Filter to creative assets updated on or after this date - name: updated_date_to in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Filter to creative assets updated on or before this date title: Updated Date To description: Filter to creative assets updated on or before this date - name: sizes in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' description: Filter by size(s) title: Sizes description: Filter by size(s) - name: file_extensions in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' description: Filter by file extension(s) title: File Extensions description: Filter by file extension(s) - name: created_date_from in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Filter to creative assets created on or after this date title: Created Date From description: Filter to creative assets created on or after this date - name: created_date_to in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Filter to creative assets created on or before this date title: Created Date To description: Filter to creative assets created on or before this date - name: created_by in: query required: false schema: anyOf: - type: integer - type: 'null' description: Filter by creator user ID title: Created By description: Filter by creator user ID - name: organization_ids in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' description: Filter by organization ID(s) title: Organization Ids description: Filter by organization ID(s) - name: account_ids in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' description: Filter by account ID(s) title: Account Ids description: Filter by account ID(s) - name: status in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/CreativeAssetStatus' - type: 'null' description: Filter by status(es) title: Status description: Filter by status(es) - name: types in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/CreativeAssetType' - type: 'null' description: Filter by asset type(s) title: Types description: Filter by asset type(s) - name: name in: query required: false schema: anyOf: - type: string - type: 'null' description: Search by name (case-insensitive substring match) title: Name description: Search by name (case-insensitive substring match) - name: search in: query required: false schema: anyOf: - type: string - type: 'null' description: Search by name (alias for name) title: Search description: Search by name (alias for name) - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaginatedCreativeAssetsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /creative_assets/{creative_asset_id}: get: tags: - Creative Assets summary: Get Creative Asset description: Gets a creative asset operationId: get_creative_asset security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_asset_id in: path required: true schema: type: integer title: Creative Asset Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreativeAssetModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error delete: tags: - Creative Assets summary: Delete Creative Asset description: Deletes a creative asset operationId: delete_creative_asset security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_asset_id in: path required: true schema: type: integer title: Creative Asset Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /creatives: post: tags: - Creatives summary: Create Creative description: Creates a creative operationId: create_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: adgroup_id in: query required: true schema: type: integer title: Adgroup Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCreativeModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreativeModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error get: tags: - Creatives summary: Get Creatives description: Gets all creatives in an ad group operationId: get_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: limit in: query required: false schema: type: integer maximum: 100 exclusiveMinimum: 1 description: Number of creatives to limit response to default: 10 title: Limit description: Number of creatives to limit response to - name: page_num in: query required: false schema: type: integer minimum: 1 description: Page number to retrieve. Starts at 1. default: 1 title: Page Num description: Page number to retrieve. Starts at 1. - name: sort_order in: query required: false schema: $ref: '#/components/schemas/SortOrder' description: Sorts creatives by name default: asc description: Sorts creatives by name - name: updated_since in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limits results to creatives updated since a unix timestamp title: Updated Since description: Limits results to creatives updated since a unix timestamp - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: adgroup_id in: query required: true schema: type: integer title: Adgroup Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreativesModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error patch: tags: - Creatives summary: Patch Creatives description: Patches multiple creatives in a campaign operationId: patch_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: campaign_id in: query required: true schema: type: integer title: Campaign Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchCreativesModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /creatives/{creative_id}: get: tags: - Creatives summary: Get Creative description: Gets a creative operationId: get_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreativeModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error put: tags: - Creatives summary: Update Creative description: Updates a creative operationId: update_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateCreativeModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreativeModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error patch: tags: - Creatives summary: Patch Creative description: Patches a creative operationId: patch_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchCreativeModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreativeModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /creatives/{creative_id}/clone: post: tags: - Creatives summary: Clone Creative description: Clones a creative operationId: clone_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreativeModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /creatives/{creative_id}/preview: get: tags: - Creatives summary: Get Creative Preview description: Gets the creative preview using the stored CMS configuration. Video creatives return VAST XML; other types return HTML. operationId: get_creative_preview security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: {} '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /creatives/{creative_id}/landing_page_preview: get: tags: - Creatives summary: Get Creative Landing Page Preview description: Gets the landing page preview HTML for a creative operationId: get_creative_landing_page_preview security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: text/html: schema: type: string '400': content: text/html: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: text/html: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: text/html: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: text/html: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: text/html: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /direct_mail/orders: get: tags: - Direct Mail summary: Get Orders description: Gets direct mail orders for a tenant operationId: get_orders security: - api-key: [] - user-id: [] - session: [] parameters: - name: limit in: query required: false schema: type: integer maximum: 100 exclusiveMinimum: 1 description: Number of orders to limit response to default: 10 title: Limit description: Number of orders to limit response to - name: page_num in: query required: false schema: type: integer minimum: 1 description: Page number to retrieve. Starts at 1. default: 1 title: Page Num description: Page number to retrieve. Starts at 1. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrdersModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /health: get: tags: - Health summary: Get Health description: Gets server health operationId: get_health responses: '200': description: Successful Response content: application/json: schema: type: string title: Response Get Health Health Get '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' /jobs: get: tags: - Jobs summary: Get Jobs description: Gets jobs operationId: get_jobs security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: adgroup_id in: query required: false schema: anyOf: - type: integer - type: 'null' title: Adgroup Id - name: account_id in: query required: false schema: anyOf: - type: integer - type: 'null' title: Account Id - name: campaign_id in: query required: false schema: anyOf: - type: integer - type: 'null' title: Campaign Id - name: job_type in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/UploadJobType' - type: 'null' title: Job Type responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /jobs/{job_id}: get: tags: - Jobs summary: Get Job description: Gets a job operationId: get_job security: - api-key: [] - user-id: [] - session: [] parameters: - name: job_id in: path required: true schema: type: integer title: Job Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /jobs/campaign_bulk_upload: post: tags: - Jobs summary: Create Campaign Bulk Upload Job description: Creates a campaign bulk upload job operationId: create_campaign_bulk_upload_job security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /jobs/campaign_bulk_upload/{job_id}/cancel: post: tags: - Jobs summary: Cancel Campaign Bulk Upload Job description: Cancels a campaign bulk upload job operationId: cancel_campaign_bulk_upload_job security: - api-key: [] - user-id: [] - session: [] parameters: - name: job_id in: path required: true schema: type: integer title: Job Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /jobs/campaign_bulk_upload/{job_id}/confirm: post: tags: - Jobs summary: Confirm Campaign Bulk Upload Job description: Confirms a campaign bulk upload job operationId: confirm_campaign_bulk_upload_job security: - api-key: [] - user-id: [] - session: [] parameters: - name: job_id in: path required: true schema: type: integer title: Job Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /jobs/location_filter_bulk_upload: post: tags: - Jobs summary: Create Location Filter Bulk Upload Job description: Creates a location filter bulk upload job operationId: create_location_filter_bulk_upload_job security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: adgroup_id in: query required: true schema: type: integer title: Adgroup Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateLocationFilterTargetBulkUploadJobModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /jobs/campaign_bulk_download: post: tags: - Jobs summary: Create Campaign Bulk Download Job description: Creates a campaign bulk download job operationId: create_campaign_bulk_download_job security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCampaignBulkDownloadJobRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /jobs/location_filter_bulk_upload/{job_id}/confirm: post: tags: - Jobs summary: Confirm Location Filter Bulk Upload Job description: Confirms location filter bulk upload job operationId: confirm_location_filter_bulk_upload_job security: - api-key: [] - user-id: [] - session: [] parameters: - name: job_id in: path required: true schema: type: integer title: Job Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: adgroup_id in: query required: true schema: type: integer title: Adgroup Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/LocationFiltersModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /jobs/location_filter_bulk_upload/{job_id}/cancel: post: tags: - Jobs summary: Cancel Location Filter Bulk Upload Job description: Cancels location filter bulk upload job operationId: cancel_location_filter_bulk_upload_job security: - api-key: [] - user-id: [] - session: [] parameters: - name: job_id in: path required: true schema: type: integer title: Job Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: adgroup_id in: query required: true schema: type: integer title: Adgroup Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/JobModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /organizations: get: tags: - Organizations summary: Get Organizations description: Gets organizations in a tenant operationId: get_organizations security: - api-key: [] - user-id: [] - session: [] parameters: - name: limit in: query required: false schema: type: integer maximum: 100 exclusiveMinimum: 1 description: Number of organizations to limit response to default: 10 title: Limit description: Number of organizations to limit response to - name: page_num in: query required: false schema: type: integer minimum: 1 description: Page number to retrieve. Starts at 1. default: 1 title: Page Num description: Page number to retrieve. Starts at 1. - name: sort_order in: query required: false schema: $ref: '#/components/schemas/SortOrder' description: Sorts organizations by name default: asc description: Sorts organizations by name - name: updated_since in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limits results to organization updated since a unix timestamp title: Updated Since description: Limits results to organization updated since a unix timestamp - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrganizationsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error post: tags: - Organizations summary: Create Organization description: Creates an organization operationId: create_organization security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateOrganizationModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrganizationModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /organizations/{organization_id}: get: tags: - Organizations summary: Get Organization description: Gets an organization operationId: get_organization security: - api-key: [] - user-id: [] - session: [] parameters: - name: organization_id in: path required: true schema: type: integer title: Organization Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrganizationModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error put: tags: - Organizations summary: Update Organization description: Updates an organization operationId: update_organization security: - api-key: [] - user-id: [] - session: [] parameters: - name: organization_id in: path required: true schema: type: integer title: Organization Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateOrganizationModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrganizationModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error delete: tags: - Organizations summary: Delete Organization description: Deletes an organization operationId: delete_organization security: - api-key: [] - user-id: [] - session: [] parameters: - name: organization_id in: path required: true schema: type: integer title: Organization Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/distribution/supply/campaign/{campaign_id}: get: tags: - Reporting summary: Get Supply System Distribution Campaign description: Gets supply/system distribution for a campaign. key=1 device type, key=2 operating system, key=3 publisher type. Optional all_adgroups breaks out by ad group. operationId: get_supply_system_distribution_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: key in: query required: true schema: $ref: '#/components/schemas/SupplySystemDistributionKey' description: 1=device type, 2=operating system, 3=publisher type description: 1=device type, 2=operating system, 3=publisher type - name: all_adgroups in: query required: false schema: type: boolean description: When true, returns distribution grouped by ad group where applicable. default: false title: All Adgroups description: When true, returns distribution grouped by ad group where applicable. - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/SupplySystemDistributionCampaignModel' title: Response Get Supply System Distribution Campaign Reporting Distribution Supply Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/distribution/performance/campaign/{campaign_id}: get: tags: - Reporting summary: Get Performance Distribution Campaign description: Gets performance distribution for a campaign. key=1 product. key=2 goal KPI is not available in this version. Optional all_adgroups breaks out by ad group. operationId: get_performance_distribution_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: key in: query required: true schema: $ref: '#/components/schemas/PerformanceDistributionKey' description: 1=product, 2=goal KPI (not available) description: 1=product, 2=goal KPI (not available) - name: all_adgroups in: query required: false schema: type: boolean description: When true, returns distribution grouped by ad group. default: false title: All Adgroups description: When true, returns distribution grouped by ad group. - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/PerformanceDistributionCampaignModel' title: Response Get Performance Distribution Campaign Reporting Distribution Performance Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/distribution/supply/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Supply System Distribution Adgroup description: Gets supply/system distribution for an ad group. key=1 device type, key=2 operating system, key=3 publisher type. operationId: get_supply_system_distribution_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: key in: query required: true schema: $ref: '#/components/schemas/SupplySystemDistributionKey' description: 1=device type, 2=operating system, 3=publisher type description: 1=device type, 2=operating system, 3=publisher type - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/SupplySystemDistributionCampaignModel' title: Response Get Supply System Distribution Adgroup Reporting Distribution Supply Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/distribution/performance/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Performance Distribution Adgroup description: Gets performance distribution for an ad group. key=1 product, key=2 goal KPI. operationId: get_performance_distribution_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: key in: query required: true schema: $ref: '#/components/schemas/PerformanceDistributionKey' description: 1=product, 2=goal KPI description: 1=product, 2=goal KPI - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/PerformanceDistributionAdgroupModel' title: Response Get Performance Distribution Adgroup Reporting Distribution Performance Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/ctv_ott/performance/campaign/{campaign_id}: get: tags: - Reporting summary: Get Ctv Ott Performance Campaign description: Gets CTV/OTT Performance Report for a campaign operationId: get_ctv_ott_performance_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/CtvOttCampaignSortByFieldName' default: impressions - name: limit in: query required: false schema: type: integer minimum: 1 default: 10 title: Limit - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/CtvOttCampaignPerformanceModel' title: Response Get Ctv Ott Performance Campaign Reporting Ctv Ott Performance Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/ctv_ott/performance/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Ctv Ott Performance Adgroup description: Gets CTV/OTT Performance Report for adgroups in a campaign operationId: get_ctv_ott_performance_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/CtvOttCampaignSortByFieldName' default: impressions - name: limit in: query required: false schema: type: integer minimum: 1 default: 10 title: Limit - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/CtvOttAdgroupPerformanceModel' title: Response Get Ctv Ott Performance Adgroup Reporting Ctv Ott Performance Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/dow/campaign/{campaign_id}: get: tags: - Reporting summary: Get Dow Metrics Campaign description: Gets day-of-week metrics for a campaign; optionally by ad group when all_adgroups=true operationId: get_dow_metrics_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean description: When true, return metrics grouped by day and ad group default: false title: All Adgroups description: When true, return metrics grouped by day and ad group - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DowMetricsCampaignModel' title: Response Get Dow Metrics Campaign Reporting Dow Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/dow/creative/{creative_id}: get: tags: - Reporting summary: Get Dow Metrics Creative description: Gets day-of-week metrics for a creative. operationId: get_dow_metrics_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DowMetricsCreativeModel' title: Response Get Dow Metrics Creative Reporting Dow Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/dow/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Timeseries Dow Adgroup description: Gets timeseries day of week chart for an ad group operationId: get_timeseries_dow_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: data_type in: query required: false schema: $ref: '#/components/schemas/TimeseriesDowDataType' description: 'Data type: chart (averaged metrics) or full (summed totals with video funnel breakdown)' default: chart description: 'Data type: chart (averaged metrics) or full (summed totals with video funnel breakdown)' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day
- adgroup_id
- adgroup_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day, adgroup_id, and adgroup_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day
- adgroup_id
- adgroup_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day, adgroup_id, and adgroup_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesDowAdgroupModel' title: Response Get Timeseries Dow Adgroup Reporting Timeseries Dow Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/dow/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Dow Metrics Adgroup description: Gets day-of-week metrics for an ad group; optionally by creative when all_creatives=true operationId: get_dow_metrics_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_creatives in: query required: false schema: type: boolean description: When true, return metrics grouped by day of week and creative default: false title: All Creatives description: When true, return metrics grouped by day of week and creative - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DowMetricsAdgroupModel' title: Response Get Dow Metrics Adgroup Reporting Dow Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/tod/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Tod Metrics Adgroup description: Gets time-of-day hourly metrics for an ad group; optionally by creative when all_creatives=true operationId: get_tod_metrics_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_creatives in: query required: false schema: type: boolean description: When true, return metrics grouped by hour and creative default: false title: All Creatives description: When true, return metrics grouped by hour and creative - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TodMetricsAdgroupModel' title: Response Get Tod Metrics Adgroup Reporting Tod Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/tod/weekday/campaign/{campaign_id}: get: tags: - Reporting summary: Get Tod Weekday Campaign description: Gets weekday time-of-day hourly metrics for a campaign; optionally by ad group. operationId: get_tod_weekday_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean description: When true, return metrics grouped by hour and ad group default: false title: All Adgroups description: When true, return metrics grouped by hour and ad group - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TodMetricsCampaignModel' title: Response Get Tod Weekday Campaign Reporting Tod Weekday Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/tod/weekday/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Tod Weekday Adgroup description: Gets weekday time-of-day hourly metrics for an ad group; optionally by creative. operationId: get_tod_weekday_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_creatives in: query required: false schema: type: boolean description: When true, return metrics grouped by hour and creative default: false title: All Creatives description: When true, return metrics grouped by hour and creative - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TodMetricsAdgroupModel' title: Response Get Tod Weekday Adgroup Reporting Tod Weekday Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/tod/weekend/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Tod Weekend Adgroup description: Gets weekend time-of-day hourly metrics for an ad group; optionally by creative. operationId: get_tod_weekend_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_creatives in: query required: false schema: type: boolean description: When true, return metrics grouped by hour and creative default: false title: All Creatives description: When true, return metrics grouped by hour and creative - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TodMetricsAdgroupModel' title: Response Get Tod Weekend Adgroup Reporting Tod Weekend Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/tod/weekend/campaign/{campaign_id}: get: tags: - Reporting summary: Get Tod Weekend Campaign description: Gets weekend time-of-day hourly metrics for a campaign; optionally by ad group. operationId: get_tod_weekend_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean description: When true, return metrics grouped by hour and ad group default: false title: All Adgroups description: When true, return metrics grouped by hour and ad group - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TodMetricsCampaignModel' title: Response Get Tod Weekend Campaign Reporting Tod Weekend Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/dow/campaign/{campaign_id}: get: tags: - Reporting summary: Get Timeseries Dow Campaign description: Gets timeseries day of week chart for a campaign operationId: get_timeseries_dow_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: data_type in: query required: false schema: $ref: '#/components/schemas/TimeseriesDowDataType' description: 'Data type: chart (averaged metrics) or full (summed totals with video funnel breakdown)' default: chart description: 'Data type: chart (averaged metrics) or full (summed totals with video funnel breakdown)' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day
- campaign_id
- campaign_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day, campaign_id, and campaign_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day
- campaign_id
- campaign_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day, campaign_id, and campaign_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesDowCampaignModel' title: Response Get Timeseries Dow Campaign Reporting Timeseries Dow Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/dow/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Timeseries Dow Campaign Adgroups description: Gets timeseries day of week metrics for each ad group in a campaign. operationId: get_timeseries_dow_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day
- adgroup_id
- adgroup_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day, adgroup_id, and adgroup_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day
- adgroup_id
- adgroup_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day, adgroup_id, and adgroup_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesDowCampaignAdgroupsModel' title: Response Get Timeseries Dow Campaign Adgroups Reporting Timeseries Dow Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/dow/campaign/{campaign_id}/creatives: get: tags: - Reporting summary: Get Timeseries Dow Campaign Creatives description: Gets timeseries day of week metrics for each creative in a campaign. operationId: get_timeseries_dow_campaign_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesDowCampaignCreativesModel' title: Response Get Timeseries Dow Campaign Creatives Reporting Timeseries Dow Campaign Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/dow/creative/{creative_id}: get: tags: - Reporting summary: Get Timeseries Dow Creative description: Gets timeseries day of week chart for a creative operationId: get_timeseries_dow_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: data_type in: query required: false schema: $ref: '#/components/schemas/TimeseriesDowDataType' description: 'Data type: chart (averaged metrics) or full (summed totals with video funnel breakdown)' default: chart description: 'Data type: chart (averaged metrics) or full (summed totals with video funnel breakdown)' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesDowCreativeModel' title: Response Get Timeseries Dow Creative Reporting Timeseries Dow Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/dow_tod/campaign/{campaign_id}: get: tags: - Reporting summary: Get Timeseries Dow Tod Campaign description: Gets timeseries day of week and time of day metrics for a campaign. operationId: get_timeseries_dow_tod_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: data_type in: query required: false schema: $ref: '#/components/schemas/DowTodDataType' description: 'Data type: chart (averaged metrics) or full (summed totals with video breakdown)' default: chart description: 'Data type: chart (averaged metrics) or full (summed totals with video breakdown)' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day_type
- day
- hr
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day_type, day, and hr are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day_type
- day
- hr
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day_type, day, and hr are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesDowTodCampaignModel' title: Response Get Timeseries Dow Tod Campaign Reporting Timeseries Dow Tod Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/dow_tod/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Timeseries Dow Tod Campaign Adgroups description: Gets timeseries day of week and time of day metrics for each ad group in a campaign. operationId: get_timeseries_dow_tod_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day_type
- day
- hr
- adgroup_id
- adgroup_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day_type, day, hr, adgroup_id, and adgroup_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day_type
- day
- hr
- adgroup_id
- adgroup_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day_type, day, hr, adgroup_id, and adgroup_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesDowTodCampaignAdgroupsModel' title: Response Get Timeseries Dow Tod Campaign Adgroups Reporting Timeseries Dow Tod Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/dow_tod/campaign/{campaign_id}/creatives: get: tags: - Reporting summary: Get Timeseries Dow Tod Campaign Creatives description: Gets timeseries day of week and time of day metrics for each creative in a campaign. operationId: get_timeseries_dow_tod_campaign_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day_type
- day
- hr
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day_type, day, hr, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day_type
- day
- hr
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day_type, day, hr, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesDowTodCampaignCreativesModel' title: Response Get Timeseries Dow Tod Campaign Creatives Reporting Timeseries Dow Tod Campaign Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/dow_tod/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Timeseries Dow Tod Adgroup description: Gets timeseries day of week and time of day metrics for an ad group. operationId: get_timeseries_dow_tod_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: data_type in: query required: false schema: $ref: '#/components/schemas/DowTodDataType' description: 'Data type: chart (averaged metrics) or full (summed totals with video breakdown)' default: chart description: 'Data type: chart (averaged metrics) or full (summed totals with video breakdown)' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day_type
- day
- hr
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day_type, day, and hr are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day_type
- day
- hr
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day_type, day, and hr are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesDowTodAdgroupModel' title: Response Get Timeseries Dow Tod Adgroup Reporting Timeseries Dow Tod Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/dow_tod/creative/{creative_id}: get: tags: - Reporting summary: Get Timeseries Dow Tod Creative description: Gets timeseries day of week and time of day metrics for a creative. operationId: get_timeseries_dow_tod_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: data_type in: query required: false schema: $ref: '#/components/schemas/DowTodDataType' description: 'Data type: chart (averaged metrics) or full (summed totals with video breakdown)' default: chart description: 'Data type: chart (averaged metrics) or full (summed totals with video breakdown)' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day_type
- day
- hr
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day_type, day, hr, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- day_type
- day
- hr
- creative_id
- creative_name
- imp
- clks
- spt
- sa
- vst
- oh_vst
- prj_vst
- sar
- ctr
- web
- dir
- ctc
- info
- cpn
- vcr
- video_start
- video_first_quartile
- video_midpoint
- video_third_quartile
- video_end

Note: day_type, day, hr, creative_id, and creative_name are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesDowTodCreativeModel' title: Response Get Timeseries Dow Tod Creative Reporting Timeseries Dow Tod Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/tod/imp/campaign/{campaign_id}: get: tags: - Reporting summary: Get Timeseries Tod Imp Campaign description: Gets time-of-day chart metrics for a campaign. operationId: get_timeseries_tod_imp_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: imp in: query required: false schema: type: boolean description: Include impressions default: false title: Imp description: Include impressions - name: vst in: query required: false schema: type: boolean description: Include visits default: false title: Vst description: Include visits - name: oh_vst in: query required: false schema: type: boolean description: Include open hour visits default: false title: Oh Vst description: Include open hour visits - name: clks in: query required: false schema: type: boolean description: Include clicks default: false title: Clks description: Include clicks - name: ctr in: query required: false schema: type: boolean description: Include click-through rate default: false title: Ctr description: Include click-through rate - name: spt in: query required: false schema: type: boolean description: Include spend default: false title: Spt description: Include spend - name: sa in: query required: false schema: type: boolean description: Include secondary actions default: false title: Sa description: Include secondary actions - name: sar in: query required: false schema: type: boolean description: Include secondary action rate default: false title: Sar description: Include secondary action rate - name: vcr in: query required: false schema: type: boolean description: Include video completion rate default: false title: Vcr description: Include video completion rate - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesTodCampaignChartModel' title: Response Get Timeseries Tod Imp Campaign Reporting Timeseries Tod Imp Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/tod/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Timeseries Tod Campaign Adgroups description: Gets time-of-day chart metrics for each ad group in a campaign. operationId: get_timeseries_tod_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: Comma-separated list of metric fields to include in the response. At least one is required.

Available values:
- imp
- vst
- oh_vst
- clks
- ctr
- spt
- sa
- sar
- vcr title: Fields description: Comma-separated list of metric fields to include in the response. At least one is required.

Available values:
- imp
- vst
- oh_vst
- clks
- ctr
- spt
- sa
- sar
- vcr responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesTodCampaignAdgroupChartModel' title: Response Get Timeseries Tod Campaign Adgroups Reporting Timeseries Tod Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/tod/campaign/{campaign_id}/creatives: get: tags: - Reporting summary: Get Timeseries Tod Creatives Campaign description: Gets time-of-day chart metrics for each creative in a campaign. operationId: get_timeseries_tod_creatives_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: Comma-separated list of metric fields to include in the response. At least one is required.

Available values:
- imp
- vst
- oh_vst
- clks
- ctr
- spt
- sa
- sar
- vcr title: Fields description: Comma-separated list of metric fields to include in the response. At least one is required.

Available values:
- imp
- vst
- oh_vst
- clks
- ctr
- spt
- sa
- sar
- vcr responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesTodCampaignCreativesChartModel' title: Response Get Timeseries Tod Creatives Campaign Reporting Timeseries Tod Campaign Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/tod/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Timeseries Tod Adgroup description: Gets time-of-day chart metrics for an ad group. operationId: get_timeseries_tod_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesTodAdgroupModel' title: Response Get Timeseries Tod Adgroup Reporting Timeseries Tod Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/timeseries/tod/creative/{creative_id}: get: tags: - Reporting summary: Get Timeseries Tod Creative description: Gets time-of-day chart metrics for a creative. operationId: get_timeseries_tod_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: imp in: query required: false schema: type: boolean description: Include impressions default: false title: Imp description: Include impressions - name: vst in: query required: false schema: type: boolean description: Include visits default: false title: Vst description: Include visits - name: oh_vst in: query required: false schema: type: boolean description: Include open hour visits default: false title: Oh Vst description: Include open hour visits - name: clks in: query required: false schema: type: boolean description: Include clicks default: false title: Clks description: Include clicks - name: ctr in: query required: false schema: type: boolean description: Include click-through rate default: false title: Ctr description: Include click-through rate - name: spt in: query required: false schema: type: boolean description: Include spend default: false title: Spt description: Include spend - name: sa in: query required: false schema: type: boolean description: Include secondary actions default: false title: Sa description: Include secondary actions - name: sar in: query required: false schema: type: boolean description: Include secondary action rate default: false title: Sar description: Include secondary action rate - name: vcr in: query required: false schema: type: boolean description: Include video completion rate default: false title: Vcr description: Include video completion rate - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeseriesTodCampaignChartModel' title: Response Get Timeseries Tod Creative Reporting Timeseries Tod Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/product/campaign/{campaign_id}: get: tags: - Reporting summary: Get Product Insights Campaign description: Gets product insights for a campaign operationId: get_product_insights_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: is_export in: query required: false schema: type: boolean description: Get POI / Geotarget level details using this flag default: false title: Is Export description: Get POI / Geotarget level details using this flag - name: sort_by in: query required: false schema: $ref: '#/components/schemas/ProductInsightsCampaignFieldName' default: imp - name: limit in: query required: false schema: type: integer minimum: 1 default: 10 title: Limit - name: category in: query required: false schema: type: boolean description: Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants. default: true title: Category description: Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: products in: query required: false schema: anyOf: - type: string - type: 'null' description: Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- re
- rb
- ra
- ol
- ne
- lo
- la
- is
- ca
- ba
- tf
- ge
- nw
- we
- ga
- lg title: Products description: Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- re
- rb
- ra
- ol
- ne
- lo
- la
- is
- ca
- ba
- tf
- ge
- nw
- we
- ga
- lg - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- imp
- spt
- vst
- oh_vst
- clks
- ctr
- sa
- sar
- vr
- prj_vst
- prj_oh_vst
- vcr
- product_group
- product
- constraint

Note: product_group, product, and constraint are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- imp
- spt
- vst
- oh_vst
- clks
- ctr
- sa
- sar
- vr
- prj_vst
- prj_oh_vst
- vcr
- product_group
- product
- constraint

Note: product_group, product, and constraint are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ProductInsightsCampaignModel' title: Response Get Product Insights Campaign Reporting Product Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/targeting_tactic/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Product Insights Adgroup description: Gets product insights for an adgroup operationId: get_product_insights_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/ProductInsightsCampaignFieldName' default: imp - name: limit in: query required: false schema: type: integer minimum: 1 default: 10 title: Limit - name: category in: query required: false schema: type: boolean description: Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants. default: true title: Category description: Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: products in: query required: false schema: anyOf: - type: string - type: 'null' description: Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- re
- rb
- ra
- ol
- ne
- lo
- la
- is
- ca
- ba
- tf
- ge
- nw
- we
- ga
- lg title: Products description: Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- re
- rb
- ra
- ol
- ne
- lo
- la
- is
- ca
- ba
- tf
- ge
- nw
- we
- ga
- lg - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- imp
- spt
- vst
- oh_vst
- clks
- ctr
- sa
- sar
- vr
- prj_vst
- prj_oh_vst
- vcr
- product_group
- product
- constraint

Note: product_group, product, and constraint are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- imp
- spt
- vst
- oh_vst
- clks
- ctr
- sa
- sar
- vr
- prj_vst
- prj_oh_vst
- vcr
- product_group
- product
- constraint

Note: product_group, product, and constraint are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ProductInsightsCampaignModel' title: Response Get Product Insights Adgroup Reporting Targeting Tactic Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/targeting_tactic/creative/{creative_id}: get: tags: - Reporting summary: Get Product Insights Creative description: Gets product insights for a creative operationId: get_product_insights_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/ProductInsightsCampaignFieldName' default: imp - name: limit in: query required: false schema: type: integer minimum: 1 default: 10 title: Limit - name: category in: query required: false schema: type: boolean description: Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants. default: true title: Category description: Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: products in: query required: false schema: anyOf: - type: string - type: 'null' description: Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- re
- rb
- ra
- ol
- ne
- lo
- la
- is
- ca
- ba
- tf
- ge
- nw
- we
- ga
- lg title: Products description: Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- re
- rb
- ra
- ol
- ne
- lo
- la
- is
- ca
- ba
- tf
- ge
- nw
- we
- ga
- lg - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- imp
- spt
- vst
- oh_vst
- clks
- ctr
- sa
- sar
- vr
- prj_vst
- prj_oh_vst
- vcr
- product_group
- product
- constraint

Note: product_group, product, and constraint are mandatory response fields and will always be returned, regardless of what is passed in fields.' title: Fields description: 'Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- imp
- spt
- vst
- oh_vst
- clks
- ctr
- sa
- sar
- vr
- prj_vst
- prj_oh_vst
- vcr
- product_group
- product
- constraint

Note: product_group, product, and constraint are mandatory response fields and will always be returned, regardless of what is passed in fields.' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ProductInsightsCampaignModel' title: Response Get Product Insights Creative Reporting Targeting Tactic Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/product/campaign/{campaign_id}/targeting: get: tags: - Reporting summary: Get Product Insights Campaign Targeting description: Gets top N (defaults to 5) targeting strategies sorted by impressions, CTR, and VR for a campaign operationId: get_product_insights_campaign_targeting security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: type: integer minimum: 1 default: 5 title: Limit - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BestStrategiesSummaryModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/product/campaign/{campaign_id}/audience: get: tags: - Reporting summary: Get Product Insights Campaign Audience description: Gets top N (defaults to 5) audiences sorted by impressions, clicks, and visits for a campaign operationId: get_product_insights_campaign_audience security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: type: integer minimum: 1 description: Number of audiences to return default: 5 title: Limit description: Number of audiences to return - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BestAudiencesSummaryModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/product/adgroup/{adgroup_id}/targeting: get: tags: - Reporting summary: Get Product Insights Adgroup Targeting description: Gets top N (defaults to 5) targeting strategies sorted by impressions, CTR, and VR for an adgroup operationId: get_product_insights_adgroup_targeting security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: type: integer minimum: 1 default: 5 title: Limit - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BestStrategiesSummaryModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/product/adgroup/{adgroup_id}/audience: get: tags: - Reporting summary: Get Product Insights Adgroup Audience description: Gets top N (defaults to 5) audiences sorted by impressions, clicks, and visits for an adgroup operationId: get_product_insights_adgroup_audience security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: type: integer minimum: 1 description: Number of audiences to return default: 5 title: Limit description: Number of audiences to return - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BestAudiencesSummaryModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/targeting_tactic/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Product Insights Campaign Adgroups description: Gets product insights for all ad groups in a campaign. operationId: get_product_insights_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/ProductInsightsCampaignFieldName' default: imp - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: category in: query required: false schema: type: boolean description: Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants. default: true title: Category description: Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ProductInsightsCampaignAdgroupsModel' title: Response Get Product Insights Campaign Adgroups Reporting Targeting Tactic Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/targeting_tactic/campaign/{campaign_id}/creatives: get: tags: - Reporting summary: Get Product Insights Campaign Creatives description: Gets product insights for all creatives in a campaign. operationId: get_product_insights_campaign_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/ProductInsightsCampaignFieldName' default: imp - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: category in: query required: false schema: type: boolean description: Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants. default: true title: Category description: Returns audience categories when True (rollup for reseller tenants); returns specific audiences when False. No effect for non-reseller tenants. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ProductInsightsCampaignCreativesModel' title: Response Get Product Insights Campaign Creatives Reporting Targeting Tactic Campaign Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/visitation/lag_window/campaign/{campaign_id}: get: tags: - Reporting summary: Get Visitation Lag Window Campaign description: Gets the number of visits after impressions and clicks. operationId: get_visitation_lag_window_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean default: false title: All Adgroups - name: all_creatives in: query required: false schema: type: boolean default: false title: All Creatives - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/VisitationLagWindowModel' title: Response Get Visitation Lag Window Campaign Reporting Visitation Lag Window Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/visitation/svl/campaign/{campaign_id}: get: tags: - Reporting summary: Get Visitation Svl Campaign description: Gets store visitation lift metrics for a campaign. operationId: get_visitation_svl_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean default: false title: All Adgroups - name: all_creatives in: query required: false schema: type: boolean default: false title: All Creatives - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/VisitationSVLCampaignModel' title: Response Get Visitation Svl Campaign Reporting Visitation Svl Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/userinsight/visit: get: tags: - Reporting summary: Get Userinsight Visit description: Gets visit membership breakdown by brand (key=1), category (key=2), or behavioral audience (key=3). operationId: get_userinsight_visit security: - api-key: [] - user-id: [] - session: [] parameters: - name: key in: query required: false schema: type: integer description: 'Membership type: 1=brand, 2=category, 3=behavioral audience' default: 1 title: Key description: 'Membership type: 1=brand, 2=category, 3=behavioral audience' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/UserinsightVisitModel' title: Response Get Userinsight Visit Reporting Userinsight Visit Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/userinsight/visit/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Userinsight Visit Adgroup description: 'Gets adgroup-level visit membership breakdown (user insight): brand, category, or behaviour.' operationId: get_userinsight_visit_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: key in: query required: false schema: $ref: '#/components/schemas/VisitMembershipBreakdownKey' description: 'Membership type: brand (1), category (2), or behaviour (3).' default: 1 description: 'Membership type: brand (1), category (2), or behaviour (3).' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/VisitMembershipBreakdownAdgroupModel' title: Response Get Userinsight Visit Adgroup Reporting Userinsight Visit Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/userinsight/visit/campaign/{campaign_id}: get: tags: - Reporting summary: Get Userinsight Visit Campaign description: 'Gets campaign-level visit membership breakdown (user insight): brand, category, or behaviour.' operationId: get_userinsight_visit_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: key in: query required: false schema: $ref: '#/components/schemas/VisitMembershipBreakdownKey' description: 'Membership type: brand (1), category (2), or behaviour (3).' default: 1 description: 'Membership type: brand (1), category (2), or behaviour (3).' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/VisitMembershipBreakdownCampaignModel' title: Response Get Userinsight Visit Campaign Reporting Userinsight Visit Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/visitation/lag_window/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Visitation Lag Window Adgroup description: Gets the number of visits after impressions and clicks for an ad group. operationId: get_visitation_lag_window_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_creatives in: query required: false schema: type: boolean default: false title: All Creatives - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/VisitationLagWindowModel' title: Response Get Visitation Lag Window Adgroup Reporting Visitation Lag Window Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/visitation/lag_window/creative/{creative_id}: get: tags: - Reporting summary: Get Visitation Lag Window Creative description: Gets the number of visits after impressions and clicks for a creative. operationId: get_visitation_lag_window_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/VisitationLagWindowModel' title: Response Get Visitation Lag Window Creative Reporting Visitation Lag Window Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/incremental_visits/campaign/{campaign_id}: get: tags: - Reporting summary: Get Incremental Visits Campaign description: Gets incremental visits by visit frequency bucket for a campaign. operationId: get_incremental_visits_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/IncrementalVisitsCampaignModel' title: Response Get Incremental Visits Campaign Reporting Incremental Visits Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/incremental_visits/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Incremental Visits Campaign Adgroup description: Gets incremental visits by visit frequency bucket for each ad group in a campaign. operationId: get_incremental_visits_campaign_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/IncrementalVisitsCampaignAdgroupModel' title: Response Get Incremental Visits Campaign Adgroup Reporting Incremental Visits Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/incremental_visits/campaign/{campaign_id}/creatives: get: tags: - Reporting summary: Get Incremental Visits Campaign Creatives description: Gets incremental visits by visit frequency bucket for each creative in a campaign. operationId: get_incremental_visits_campaign_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/IncrementalVisitsCreativeModel' title: Response Get Incremental Visits Campaign Creatives Reporting Incremental Visits Campaign Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/incremental_visits/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Incremental Visits Adgroup description: Gets incremental visits by visit frequency bucket for an ad group. operationId: get_incremental_visits_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/IncrementalVisitsAdgroupModel' title: Response Get Incremental Visits Adgroup Reporting Incremental Visits Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/incremental_visits/creative/{creative_id}: get: tags: - Reporting summary: Get Incremental Visits Creative description: Gets incremental visits by visit frequency bucket for a creative. operationId: get_incremental_visits_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/IncrementalVisitsCreativeModel' title: Response Get Incremental Visits Creative Reporting Incremental Visits Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/locations/imp/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Locations Imp Adgroup description: Gets impressed locations for an ad group. operationId: get_locations_imp_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/LocationImpressionAdgroupModel' title: Response Get Locations Imp Adgroup Reporting Locations Imp Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/locations/imp/campaign/{campaign_id}: get: tags: - Reporting summary: Get Locations Imp Campaign description: Gets impressed locations for a campaign. operationId: get_locations_imp_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: all_adgroups in: query required: false schema: type: boolean description: When true, returns impressed locations grouped by ad group. default: false title: All Adgroups description: When true, returns impressed locations grouped by ad group. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/LocationImpressionCampaignModel' title: Response Get Locations Imp Campaign Reporting Locations Imp Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/locations/visit/campaign/{campaign_id}: get: tags: - Reporting summary: Get Locations Visit Campaign description: Gets visited locations for a campaign. operationId: get_locations_visit_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: all_adgroups in: query required: false schema: type: boolean description: When true, returns visited locations grouped by ad group. default: false title: All Adgroups description: When true, returns visited locations grouped by ad group. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/LocationVisitCampaignModel' title: Response Get Locations Visit Campaign Reporting Locations Visit Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/locations/visit/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Locations Visit Adgroup description: Gets visited locations for an ad group. operationId: get_locations_visit_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/LocationVisitAdgroupModel' title: Response Get Locations Visit Adgroup Reporting Locations Visit Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/top_locations/campaign/{campaign_id}: get: tags: - Reporting summary: Get Top Locations Campaign description: Gets top locations (impressions-based) for a campaign by state, DMA, or zipcode. operationId: get_top_locations_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: location_type in: query required: true schema: $ref: '#/components/schemas/TopLocationsCampaignFieldName' description: 'Location type: state, dma, or zipcode' description: 'Location type: state, dma, or zipcode' - name: metric in: query required: false schema: $ref: '#/components/schemas/TopLocationsMetricName' description: 'Metric to sort by: impressions, clicks, ctr, secondary_actions, or visits' default: impressions description: 'Metric to sort by: impressions, clicks, ctr, secondary_actions, or visits' - name: key in: query required: false schema: type: integer description: 1 for top locations, 2 for bottom locations, 0 for all records (no limit) default: 1 title: Key description: 1 for top locations, 2 for bottom locations, 0 for all records (no limit) - name: sw_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern latitude title: Sw Lat description: Southwestern latitude - name: sw_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern longitude title: Sw Lng description: Southwestern longitude - name: ne_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern latitude title: Ne Lat description: Northeastern latitude - name: ne_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern longitude title: Ne Lng description: Northeastern longitude - name: limit in: query required: false schema: type: integer minimum: 1 description: Number of locations to return default: 10 title: Limit description: Number of locations to return - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TopLocationsCampaignModel' title: Response Get Top Locations Campaign Reporting Top Locations Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/top_locations/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Top Locations Adgroup description: Gets top locations (impressions-based) for an ad group by state, DMA, or zipcode. operationId: get_top_locations_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: location_type in: query required: true schema: $ref: '#/components/schemas/TopLocationsCampaignFieldName' description: 'Location type: state, dma, or zipcode' description: 'Location type: state, dma, or zipcode' - name: metric in: query required: false schema: $ref: '#/components/schemas/TopLocationsMetricName' description: 'Metric to sort by: impressions, clicks, ctr, secondary_actions, or visits' default: impressions description: 'Metric to sort by: impressions, clicks, ctr, secondary_actions, or visits' - name: key in: query required: false schema: type: integer description: 1 for top locations, 2 for bottom locations, 0 for all records (no limit) default: 1 title: Key description: 1 for top locations, 2 for bottom locations, 0 for all records (no limit) - name: sw_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern latitude title: Sw Lat description: Southwestern latitude - name: sw_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern longitude title: Sw Lng description: Southwestern longitude - name: ne_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern latitude title: Ne Lat description: Northeastern latitude - name: ne_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern longitude title: Ne Lng description: Northeastern longitude - name: limit in: query required: false schema: type: integer minimum: 1 description: Number of locations to return default: 10 title: Limit description: Number of locations to return - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TopLocationsAdgroupModel' title: Response Get Top Locations Adgroup Reporting Top Locations Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/top_sv_locations/campaign/{campaign_id}: get: tags: - Reporting summary: Get Top Sv Locations Campaign description: Gets data for visited locations. operationId: get_top_sv_locations_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: location_type in: query required: true schema: $ref: '#/components/schemas/TopSVLocationsCampaignFieldName' description: Please select a location type description: Please select a location type - name: key in: query required: false schema: type: integer description: Enter 1 to get top 10 locations, 2 to get bottom 10 locations, 0 to get all the records default: 1 title: Key description: Enter 1 to get top 10 locations, 2 to get bottom 10 locations, 0 to get all the records - name: sw_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern Latitude Coordinates title: Sw Lat description: Southwestern Latitude Coordinates - name: sw_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern Longitude Coordinates title: Sw Lng description: Southwestern Longitude Coordinates - name: ne_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern Latitude Coordinates title: Ne Lat description: Northeastern Latitude Coordinates - name: ne_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern Longitude Coordinates title: Ne Lng description: Northeastern Longitude Coordinates - name: blueprint_polygon_info in: query required: false schema: type: boolean description: Includes blueprint polygon data in the output (applicable only for "address" type locations) default: false title: Blueprint Polygon Info description: Includes blueprint polygon data in the output (applicable only for "address" type locations) - name: limit in: query required: false schema: type: integer minimum: 1 description: Number of locations to return default: 10 title: Limit description: Number of locations to return - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TopSVLocationsCampaignModel' title: Response Get Top Sv Locations Campaign Reporting Top Sv Locations Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/top_sv_locations/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Top Sv Locations Adgroup description: Gets data for visited locations for an ad group. operationId: get_top_sv_locations_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: location_type in: query required: true schema: $ref: '#/components/schemas/TopSVLocationsCampaignFieldName' description: Please select a location type description: Please select a location type - name: key in: query required: false schema: type: integer description: Enter 1 to get top 10 locations, 2 to get bottom 10 locations, 0 to get all the records default: 1 title: Key description: Enter 1 to get top 10 locations, 2 to get bottom 10 locations, 0 to get all the records - name: sw_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern Latitude Coordinates title: Sw Lat description: Southwestern Latitude Coordinates - name: sw_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern Longitude Coordinates title: Sw Lng description: Southwestern Longitude Coordinates - name: ne_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern Latitude Coordinates title: Ne Lat description: Northeastern Latitude Coordinates - name: ne_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern Longitude Coordinates title: Ne Lng description: Northeastern Longitude Coordinates - name: blueprint_polygon_info in: query required: false schema: type: boolean description: Includes blueprint polygon data in the output (applicable only for "address" type locations) default: false title: Blueprint Polygon Info description: Includes blueprint polygon data in the output (applicable only for "address" type locations) - name: limit in: query required: false schema: type: integer minimum: 1 description: Number of locations to return default: 10 title: Limit description: Number of locations to return - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TopSVLocationsAdgroupModel' title: Response Get Top Sv Locations Adgroup Reporting Top Sv Locations Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/top_imp_locations/campaign/{campaign_id}: get: tags: - Reporting summary: Get Top Imp Locations Campaign description: Gets top or bottom locations by impressions, clicks, or secondary actions for a campaign. operationId: get_top_imp_locations_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: location_type in: query required: true schema: $ref: '#/components/schemas/TopImpLocationsAdgroupFieldName' description: Location type description: Location type - name: metric in: query required: false schema: $ref: '#/components/schemas/TopImpLocationsAdgroupMetricName' description: Metric to sort by (impressions, clicks, total_sa) default: impressions description: Metric to sort by (impressions, clicks, total_sa) - name: key in: query required: false schema: type: integer description: 1 for top locations, 2 for bottom locations default: 1 title: Key description: 1 for top locations, 2 for bottom locations - name: limit in: query required: false schema: type: integer minimum: -1 description: Max number of records; use -1 for no limit default: 10 title: Limit description: Max number of records; use -1 for no limit - name: sw_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern latitude (bounding box) title: Sw Lat description: Southwestern latitude (bounding box) - name: sw_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern longitude (bounding box) title: Sw Lng description: Southwestern longitude (bounding box) - name: ne_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern latitude (bounding box) title: Ne Lat description: Northeastern latitude (bounding box) - name: ne_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern longitude (bounding box) title: Ne Lng description: Northeastern longitude (bounding box) - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TopImpLocationsCampaignModel' title: Response Get Top Imp Locations Campaign Reporting Top Imp Locations Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/top_imp_locations/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Top Imp Locations Adgroup description: Gets top or bottom locations by impressions, clicks, or secondary actions for an ad group. operationId: get_top_imp_locations_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: location_type in: query required: true schema: $ref: '#/components/schemas/TopImpLocationsAdgroupFieldName' description: Location type description: Location type - name: metric in: query required: false schema: $ref: '#/components/schemas/TopImpLocationsAdgroupMetricName' description: Metric to sort by (impressions, clicks, total_sa) default: impressions description: Metric to sort by (impressions, clicks, total_sa) - name: key in: query required: false schema: type: integer description: 1 for top locations, 2 for bottom locations default: 1 title: Key description: 1 for top locations, 2 for bottom locations - name: limit in: query required: false schema: type: integer minimum: -1 description: Max number of records; use -1 for no limit default: 10 title: Limit description: Max number of records; use -1 for no limit - name: sw_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern latitude (bounding box) title: Sw Lat description: Southwestern latitude (bounding box) - name: sw_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Southwestern longitude (bounding box) title: Sw Lng description: Southwestern longitude (bounding box) - name: ne_lat in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern latitude (bounding box) title: Ne Lat description: Northeastern latitude (bounding box) - name: ne_lng in: query required: false schema: anyOf: - type: number - type: 'null' description: Northeastern longitude (bounding box) title: Ne Lng description: Northeastern longitude (bounding box) - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TopImpLocationsAdgroupModel' title: Response Get Top Imp Locations Adgroup Reporting Top Imp Locations Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/totals/account/{account_id}: get: tags: - Reporting summary: Get Totals Account description: Gets cumulative performance metrics for all campaigns in an account operationId: get_totals_account security: - api-key: [] - user-id: [] - session: [] parameters: - name: account_id in: path required: true schema: type: integer title: Account Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TotalsCampaignModel' title: Response Get Totals Account Reporting Totals Account Account Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/totals/organization/{organization_id}: get: tags: - Reporting summary: Get Totals Organization description: Gets cumulative performance metrics for all campaigns in an organization operationId: get_totals_organization security: - api-key: [] - user-id: [] - session: [] parameters: - name: organization_id in: path required: true schema: type: integer description: Organization ID title: Organization Id description: Organization ID - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer description: Tenant ID title: Tenant Id description: Tenant ID responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TotalsCampaignModel' title: Response Get Totals Organization Reporting Totals Organization Organization Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/totals/tenant: post: tags: - Reporting summary: Post Totals Tenant description: Gets tenant-level totals with up-to-date spend for a list of campaigns operationId: post_totals_tenant security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TotalsTenantRequestModel' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TotalsTenantResponseModel' title: Response Post Totals Tenant Reporting Totals Tenant Post '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/totals/v2/account/{account_id}: get: tags: - Reporting summary: Get Totals Account V2 description: Gets account-level totals v2 with up-to-date spend operationId: get_totals_account_v2 security: - api-key: [] - user-id: [] - session: [] parameters: - name: account_id in: path required: true schema: type: integer title: Account Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TotalsCampaignModel' title: Response Get Totals Account V2 Reporting Totals V2 Account Account Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/tav/campaign/{campaign_id}: get: tags: - Reporting summary: Get Total Attributed Visits Campaign description: Gets total attributed visits estimate for a specific campaign operationId: get_total_attributed_visits_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: post_date in: query required: true schema: type: string format: date description: Post date in YYYY-MM-DD title: Post Date description: Post date in YYYY-MM-DD - name: version in: query required: false schema: type: string description: Version filter default: '3.0' title: Version description: Version filter - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TotalAttributedVisitsModel' title: Response Get Total Attributed Visits Campaign Reporting Tav Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/tav/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Total Attributed Visits Campaign Adgroups description: Gets total attributed visits estimate per ad group for a specific campaign operationId: get_total_attributed_visits_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: post_date in: query required: true schema: type: string format: date description: Post date in YYYY-MM-DD title: Post Date description: Post date in YYYY-MM-DD - name: version in: query required: false schema: type: string description: Version filter default: '3.0' title: Version description: Version filter - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TotalAttributedVisitsAdgroupModel' title: Response Get Total Attributed Visits Campaign Adgroups Reporting Tav Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/totals/campaign/{campaign_id}: get: tags: - Reporting summary: Get Totals Campaign description: Gets detailed performance metrics for a specific campaign operationId: get_totals_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean default: false title: All Adgroups - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TotalsCampaignModel' title: Response Get Totals Campaign Reporting Totals Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/totals/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Totals Adgroup description: Gets cumulative performance metrics for an ad group; optionally grouped by creative when all_creatives=true operationId: get_totals_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_creatives in: query required: false schema: type: boolean description: When true, return report grouped by creative id default: false title: All Creatives description: When true, return report grouped by creative id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TotalsCampaignModel' title: Response Get Totals Adgroup Reporting Totals Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/demographics/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Demographics Partial Adgroup description: Gets adgroup demographics (partial) metrics by gender and age operationId: get_demographics_partial_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: type: array items: type: string description: 'Filter of enabled metrics. Allowed: imp,vst,clks,ctr,rch,vcr,ltr. Provide at least one.' default: [] title: Sort By description: 'Filter of enabled metrics. Allowed: imp,vst,clks,ctr,rch,vcr,ltr. Provide at least one.' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DemographicsPartialGenderModel' title: Response Get Demographics Partial Adgroup Reporting Demographics Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/totals/creative/{creative_id}: get: tags: - Reporting summary: Get Totals Creative description: Gets cumulative performance metrics for a creative operationId: get_totals_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TotalsCampaignModel' title: Response Get Totals Creative Reporting Totals Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/totals/campaign/{campaign_id}/creatives: get: tags: - Reporting summary: Get Totals Campaign Creatives description: Gets top N (defaults to 3) creatives with the most impressions for a specific campaign operationId: get_totals_campaign_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: type: integer minimum: 1 description: Number of creatives to limit response to default: 3 title: Limit description: Number of creatives to limit response to - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TotalsCampaignCreativesModel' title: Response Get Totals Campaign Creatives Reporting Totals Campaign Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/podcast_topic/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audio Podcast Topic Metrics Campaign description: Audio podcast topic metrics for a specific campaign. operationId: get_audio_podcast_topic_metrics_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudioPodcastFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: all_adgroups in: query required: false schema: type: boolean description: Get all adgroups default: false title: All Adgroups description: Get all adgroups - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioPodcastTopicMetricsCampaignModel' title: Response Get Audio Podcast Topic Metrics Campaign Reporting Audio Podcast Topic Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/podcast_topic/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Audio Podcast Topic Metrics Adgroup description: Audio podcast topic metrics for a specific adgroup. operationId: get_audio_podcast_topic_metrics_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudioPodcastFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioPodcastTopicMetricsAdgroupModel' title: Response Get Audio Podcast Topic Metrics Adgroup Reporting Audio Podcast Topic Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/podcast_series/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audio Podcast Series Metrics Campaign description: Audio podcast series metrics for a specific campaign. operationId: get_audio_podcast_series_metrics_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudioPodcastFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: all_adgroups in: query required: false schema: type: boolean description: Get all adgroups default: false title: All Adgroups description: Get all adgroups - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioPodcastSeriesMetricsCampaignModel' title: Response Get Audio Podcast Series Metrics Campaign Reporting Audio Podcast Series Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/podcast_series/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Audio Podcast Series Metrics Adgroup description: Audio podcast series metrics for a specific adgroup. operationId: get_audio_podcast_series_metrics_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudioPodcastFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioPodcastSeriesMetricsAdgroupModel' title: Response Get Audio Podcast Series Metrics Adgroup Reporting Audio Podcast Series Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/recommendations/campaign/{campaign_id}: get: tags: - Reporting summary: Get Campaign Recommendations description: Get recommendations for a specific campaign. operationId: get_campaign_recommendations security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RecommendationsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/recommendations/campaign/{campaign_id}/{recommendation_id}/dismiss: put: tags: - Reporting summary: Dismiss Recommendation description: Dismiss a recommendation operationId: dismiss_recommendation security: - api-key: [] - user-id: [] - session: [] parameters: - name: recommendation_id in: path required: true schema: type: integer title: Recommendation Id - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/recommendations/{recommendation_id}/apply: put: tags: - Reporting summary: Apply Recommendation description: Apply a recommendation operationId: apply_recommendation security: - api-key: [] - user-id: [] - session: [] parameters: - name: recommendation_id in: path required: true schema: type: integer description: Recommendation ID title: Recommendation Id description: Recommendation ID - name: tenant_id in: query required: true schema: type: integer description: Tenant ID title: Tenant Id description: Tenant ID responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/recommendations/account/{account_id}/count: post: tags: - Reporting summary: Get Recommendation Count description: Gets the recommendations count by campaign in an account operationId: get_recommendation_count security: - api-key: [] - user-id: [] - session: [] parameters: - name: account_id in: path required: true schema: type: integer title: Account Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RecommendationCountRequestModel' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/RecommendationCountModel' title: Response Get Recommendation Count Reporting Recommendations Account Account Id Count Post '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/foot_traffic_attribution: post: tags: - Reporting summary: Get Foot Traffic Attribution description: Gets foot traffic attribution report with visit and visitor metrics operationId: get_foot_traffic_attribution security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FootTrafficAttributionRequestModel' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/FootTrafficAttributionModel' title: Response Get Foot Traffic Attribution Reporting Foot Traffic Attribution Post '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/foot_traffic_attribution/detailed: post: tags: - Reporting summary: Get Foot Traffic Attribution Detailed description: Gets detailed foot traffic attribution report with visit and visitor metrics operationId: get_foot_traffic_attribution_detailed security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FootTrafficAttributionDetailedRequestModel' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/FootTrafficAttributionDetailedModel' title: Response Get Foot Traffic Attribution Detailed Reporting Foot Traffic Attribution Detailed Post '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/foot_traffic_attribution/v2/order/{order_id}/summary: get: tags: - Reporting summary: Get Foot Traffic Attribution V2 Order Summary description: Gets foot traffic attribution summary for a specific order operationId: get_foot_traffic_attribution_v2_order_summary security: - api-key: [] - user-id: [] - session: [] parameters: - name: order_id in: path required: true schema: type: string description: This is the unique identifier which refers to a campaign. title: Order Id description: This is the unique identifier which refers to a campaign. - name: start_date in: query required: false schema: type: string format: date description: Date should be in YYYY-MM-DD, default is current date title: Start Date description: Date should be in YYYY-MM-DD, default is current date - name: end_date in: query required: false schema: type: string format: date description: Date should be in YYYY-MM-DD, default is current date title: End Date description: Date should be in YYYY-MM-DD, default is current date - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/FootTrafficAttributionV2OrderSummaryModel' title: Response Get Foot Traffic Attribution V2 Order Summary Reporting Foot Traffic Attribution V2 Order Order Id Summary Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/foot_traffic_attribution/v2/order/{order_id}/detailed: get: tags: - Reporting summary: Get Foot Traffic Attribution V2 Detailed description: Gets detailed foot traffic attribution report for a specific order operationId: get_foot_traffic_attribution_v2_detailed security: - api-key: [] - user-id: [] - session: [] parameters: - name: order_id in: path required: true schema: type: string description: This is the unique identifier which refers to a campaign. title: Order Id description: This is the unique identifier which refers to a campaign. - name: start_date in: query required: false schema: type: string format: date description: Date should be in YYYY-MM-DD, default is current date title: Start Date description: Date should be in YYYY-MM-DD, default is current date - name: end_date in: query required: false schema: type: string format: date description: Date should be in YYYY-MM-DD, default is current date title: End Date description: Date should be in YYYY-MM-DD, default is current date - name: page in: query required: false schema: type: integer minimum: 1 description: Page number (1-based) default: 1 title: Page description: Page number (1-based) - name: page_size in: query required: false schema: type: integer maximum: 1000 minimum: 1 description: Number of items per page (max 1000) default: 100 title: Page Size description: Number of items per page (max 1000) - name: fields in: query required: false schema: anyOf: - type: string - type: 'null' description: Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- campaign_total_impressions
- campaign_identifiable_impressions
- observed_attributed_visits
- true_visits
- cumulative_visits title: Fields description: Comma-separated list of fields to return. If none are provided, all will be returned.

Available values:
- campaign_total_impressions
- campaign_identifiable_impressions
- observed_attributed_visits
- true_visits
- cumulative_visits - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/FootTrafficAttributionV2DetailedModel' title: Response Get Foot Traffic Attribution V2 Detailed Reporting Foot Traffic Attribution V2 Order Order Id Detailed Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/fp_poitag/campaign/{campaign_id}: get: tags: - Reporting summary: Get Fp Poitag Campaign description: Gets first-party POI tag breakdown metrics for a specific campaign. operationId: get_fp_poitag_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: fp_poitag in: query required: false schema: anyOf: - type: string - type: 'null' description: POI tag filter; omit for all tags (same as -1). title: Fp Poitag description: POI tag filter; omit for all tags (same as -1). - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean description: When true, return metrics split by ad group. default: false title: All Adgroups description: When true, return metrics split by ad group. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/FpPoitagCampaignResponseModel' title: Response Get Fp Poitag Campaign Reporting Fp Poitag Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/fp_poitag/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Fp Poitag Adgroup description: Gets first-party POI tag breakdown metrics for a specific ad group. operationId: get_fp_poitag_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: fp_poitag in: query required: false schema: anyOf: - type: string - type: 'null' description: POI tag filter; omit for all tags (same as -1). title: Fp Poitag description: POI tag filter; omit for all tags (same as -1). - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/FpPoitagAdgroupResponseModel' title: Response Get Fp Poitag Adgroup Reporting Fp Poitag Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/mobile/category/campaign/{campaign_id}: get: tags: - Reporting summary: Get Mobile Category Campaign description: Gets mobile category metrics for a specific campaign. operationId: get_mobile_category_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/MobileCategoryFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/MobileCategoryCampaignModel' title: Response Get Mobile Category Campaign Reporting Mobile Category Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/mobile/category/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Mobile Category Adgroup description: Gets mobile category metrics for a specific ad group. operationId: get_mobile_category_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/MobileCategoryFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/MobileCategoryAdgroupModel' title: Response Get Mobile Category Adgroup Reporting Mobile Category Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/mobile/category/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Mobile Category All Adgroups description: Gets mobile category metrics for all ad groups in a specific campaign. operationId: get_mobile_category_all_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/MobileCategoryFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/MobileCategoryCampaignAllAdgroupsModel' title: Response Get Mobile Category All Adgroups Reporting Mobile Category Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/demographics/campaign/{campaign_id}: get: tags: - Reporting summary: Get Demographics Partial Campaign description: Gets campaign demographics (partial) metrics by gender and age operationId: get_demographics_partial_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: type: array items: type: string description: 'Filter of enabled metrics. Allowed: imp,vst,clks,ctr,rch,vcr,ltr. Provide at least one.' default: [] title: Sort By description: 'Filter of enabled metrics. Allowed: imp,vst,clks,ctr,rch,vcr,ltr. Provide at least one.' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DemographicsPartialGenderModel' title: Response Get Demographics Partial Campaign Reporting Demographics Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/demographics/campaign/{campaign_id}/age-gender-distribution: get: tags: - Reporting summary: Get Age Gender Distribution Campaign description: Gets age-gender distribution metrics for a campaign (optionally by ad group). operationId: get_age_gender_distribution_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: all_adgroups in: query required: false schema: type: boolean description: When true, returns distribution grouped by ad group in addition to age and gender. default: false title: All Adgroups description: When true, returns distribution grouped by ad group in addition to age and gender. - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AgeGenderDistributionCampaignModel' title: Response Get Age Gender Distribution Campaign Reporting Demographics Campaign Campaign Id Age Gender Distribution Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/demographic/adgroups/{adgroup_id}/age_gender_distribution: get: tags: - Reporting summary: Get Age Gender Distribution Adgroup description: Gets age-gender distribution metrics for an ad group. operationId: get_age_gender_distribution_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AgeGenderDistributionCampaignModel' title: Response Get Age Gender Distribution Adgroup Reporting Demographic Adgroups Adgroup Id Age Gender Distribution Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience_affinity/creative/{creative_id}: get: tags: - Reporting summary: Get Audience Affinity Creative description: Gets audience affinity metrics for a specific creative. operationId: get_audience_affinity_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceAffinityFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 1 title: Min Imp Count description: Minimum impression count filter - name: category_id in: query required: false schema: anyOf: - type: integer - type: 'null' description: Filter by audience category ID title: Category Id description: Filter by audience category ID - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceAffinityCreativeModel' title: Response Get Audience Affinity Creative Reporting Audience Affinity Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/category/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audience Category Campaign description: Gets audience category metrics for a specific campaign. operationId: get_audience_category_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceCategoryFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 1 title: Min Imp Count description: Minimum impression count filter - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceCategoryCampaignModel' title: Response Get Audience Category Campaign Reporting Audience Category Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience_affinity/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audience Affinity Campaign description: Gets audience affinity metrics for a specific campaign. operationId: get_audience_affinity_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceAffinityFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 1 title: Min Imp Count description: Minimum impression count filter - name: category_id in: query required: false schema: anyOf: - type: integer - type: 'null' description: Filter by audience category ID title: Category Id description: Filter by audience category ID - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceAffinityCampaignModel' title: Response Get Audience Affinity Campaign Reporting Audience Affinity Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/brand_affinity/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Brand Affinity Adgroup description: Gets brand affinity (audience insights brand) metrics for a specific ad group. operationId: get_brand_affinity_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/BrandAffinityAdgroupFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count per brand default: 10000 title: Min Imp Count description: Minimum impression count per brand - name: sic_code in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by SIC code title: Sic Code description: Filter by SIC code - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/BrandAffinityAdgroupModel' title: Response Get Brand Affinity Adgroup Reporting Brand Affinity Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/brand_affinity/campaign/{campaign_id}: get: tags: - Reporting summary: Get Brand Affinity Campaign description: Gets brand affinity (audience insights brand) metrics for a specific campaign. operationId: get_brand_affinity_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/BrandAffinityCampaignFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count per brand default: 10000 title: Min Imp Count description: Minimum impression count per brand - name: sic_code in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by SIC code title: Sic Code description: Filter by SIC code - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/BrandAffinityCampaignModel' title: Response Get Brand Affinity Campaign Reporting Brand Affinity Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/brand_affinity/campaigns/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Brand Affinity Campaign Adgroups description: Gets brand affinity metrics for all adgroups in a campaign (export scope). operationId: get_brand_affinity_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/BrandAffinityCampaignAdgroupsFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count per brand default: 5000 title: Min Imp Count description: Minimum impression count per brand - name: sic_code in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by SIC code title: Sic Code description: Filter by SIC code - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/BrandAffinityCampaignAdgroupsModel' title: Response Get Brand Affinity Campaign Adgroups Reporting Brand Affinity Campaigns Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/brand_affinity/campaigns/{campaign_id}/creatives: get: tags: - Reporting summary: Get Brand Affinity Campaign Creatives description: Gets brand affinity metrics for all creatives in a campaign (export scope). operationId: get_brand_affinity_campaign_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/BrandAffinityCampaignCreativesFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count per brand default: 5000 title: Min Imp Count description: Minimum impression count per brand - name: sic_code in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by SIC code title: Sic Code description: Filter by SIC code - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/BrandAffinityCampaignCreativesModel' title: Response Get Brand Affinity Campaign Creatives Reporting Brand Affinity Campaigns Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/brand_affinity/creative/{creative_id}: get: tags: - Reporting summary: Get Brand Affinity Creative description: Gets brand affinity (audience insights brand) metrics for a specific creative. operationId: get_brand_affinity_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/BrandAffinityCreativeFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count per brand default: 10000 title: Min Imp Count description: Minimum impression count per brand - name: sic_code in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by SIC code title: Sic Code description: Filter by SIC code - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/BrandAffinityCreativeModel' title: Response Get Brand Affinity Creative Reporting Brand Affinity Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/userinsight/imp/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Imp Membership Breakdown Adgroup description: 'Gets ad group-level impression membership breakdown (user insight): brand, category, or behaviour.' operationId: get_imp_membership_breakdown_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: key in: query required: false schema: $ref: '#/components/schemas/ImpMembershipBreakdownKey' description: 'Membership type: brand (1), category (2), or behaviour (3).' default: 1 description: 'Membership type: brand (1), category (2), or behaviour (3).' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ImpMembershipBreakdownAdgroupModel' title: Response Get Imp Membership Breakdown Adgroup Reporting Userinsight Imp Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/userinsight/imp/campaign/{campaign_id}: get: tags: - Reporting summary: Get Imp Membership Breakdown Campaign description: 'Gets campaign-level impression membership breakdown (user insight): brand, category, or behaviour.' operationId: get_imp_membership_breakdown_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: key in: query required: false schema: $ref: '#/components/schemas/ImpMembershipBreakdownKey' description: 'Membership type: brand (1), category (2), or behaviour (3).' default: 1 description: 'Membership type: brand (1), category (2), or behaviour (3).' - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ImpMembershipBreakdownCampaignModel' title: Response Get Imp Membership Breakdown Campaign Reporting Userinsight Imp Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience_affinity/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Audience Affinity Campaign Adgroups description: Gets audience affinity metrics for all adgroups in a campaign (export scope). operationId: get_audience_affinity_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceAffinityFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 5000 title: Min Imp Count description: Minimum impression count filter - name: category_id in: query required: false schema: anyOf: - type: integer - type: 'null' description: Filter by audience category ID title: Category Id description: Filter by audience category ID - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceAffinityAdgroupModel' title: Response Get Audience Affinity Campaign Adgroups Reporting Audience Affinity Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience_affinity/campaign/{campaign_id}/creatives: get: tags: - Reporting summary: Get Audience Affinity Campaign Creatives description: Gets audience affinity metrics for all creatives in a campaign. operationId: get_audience_affinity_campaign_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceAffinityCampaignCreativeFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 5000 title: Min Imp Count description: Minimum impression count filter - name: category_id in: query required: false schema: anyOf: - type: integer - type: 'null' description: Filter by audience category ID title: Category Id description: Filter by audience category ID - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceAffinityCreativeModel' title: Response Get Audience Affinity Campaign Creatives Reporting Audience Affinity Campaign Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience_affinity/v2/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audience Affinity Campaign V2 description: Gets audience affinity metrics for a specific campaign. operationId: get_audience_affinity_campaign_v2 security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceAffinityCampaignCreativeFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 1 title: Min Imp Count description: Minimum impression count filter - name: category_id in: query required: false schema: anyOf: - type: integer - type: 'null' description: Filter by audience category ID title: Category Id description: Filter by audience category ID - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceAffinityCampaignSummaryModel' title: Response Get Audience Affinity Campaign V2 Reporting Audience Affinity V2 Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience_affinity/v2/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Audience Affinity Campaign Adgroups V2 description: Gets audience affinity metrics for all adgroups in a specific campaign. operationId: get_audience_affinity_campaign_adgroups_v2 security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceAffinityFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 5000 title: Min Imp Count description: Minimum impression count filter - name: category_id in: query required: false schema: anyOf: - type: integer - type: 'null' description: Filter by audience category ID title: Category Id description: Filter by audience category ID - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceAffinityAdgroupModel' title: Response Get Audience Affinity Campaign Adgroups V2 Reporting Audience Affinity V2 Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience_affinity/v2/creative/{creative_id}: get: tags: - Reporting summary: Get Audience Affinity Creative V2 description: Gets audience affinity metrics for a specific creative (v2). operationId: get_audience_affinity_creative_v2 security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceAffinityCampaignCreativeFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 5000 title: Min Imp Count description: Minimum impression count filter - name: category_id in: query required: false schema: anyOf: - type: integer - type: 'null' description: Filter by audience category ID title: Category Id description: Filter by audience category ID - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceAffinityCreativeModel' title: Response Get Audience Affinity Creative V2 Reporting Audience Affinity V2 Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience_affinity/v2/{campaign_id}/creatives: get: tags: - Reporting summary: Get Audience Affinity Campaign Creatives V2 description: Gets audience affinity metrics for all creatives in a specific campaign. operationId: get_audience_affinity_campaign_creatives_v2 security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceAffinityCampaignCreativeFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 5000 title: Min Imp Count description: Minimum impression count filter - name: category_id in: query required: false schema: anyOf: - type: integer - type: 'null' description: Filter by audience category ID title: Category Id description: Filter by audience category ID - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceAffinityCreativeModel' title: Response Get Audience Affinity Campaign Creatives V2 Reporting Audience Affinity V2 Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience_affinity/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Audience Affinity Adgroup description: Gets audience affinity metrics for a specific adgroup. operationId: get_audience_affinity_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceAffinityFieldName' description: Sort by field default: vr description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 5000 title: Min Imp Count description: Minimum impression count filter - name: category_id in: query required: false schema: anyOf: - type: integer - type: 'null' description: Filter by audience category ID title: Category Id description: Filter by audience category ID - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceAffinityAdgroupModel' title: Response Get Audience Affinity Adgroup Reporting Audience Affinity Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience_affinity/v2/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Audience Affinity Adgroup V2 description: Gets audience affinity metrics for a specific ad group (v2). operationId: get_audience_affinity_adgroup_v2 security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceAffinityFieldName' description: Sort by field. Allowed values are defined by AudienceAffinityFieldName (see schema). default: vr description: Sort by field. Allowed values are defined by AudienceAffinityFieldName (see schema). - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 1 title: Min Imp Count description: Minimum impression count filter - name: category_id in: query required: false schema: anyOf: - type: integer - type: 'null' description: Filter by audience category ID title: Category Id description: Filter by audience category ID - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceAffinityAdgroupModel' title: Response Get Audience Affinity Adgroup V2 Reporting Audience Affinity V2 Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/category/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Audience Category Campaign All Adgroups description: Gets audience category metrics for all ad groups in a specific campaign. operationId: get_audience_category_campaign_all_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceCategoryAdgroupFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 1 title: Min Imp Count description: Minimum impression count filter - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceCategoryCampaignAllAdgroupsModel' title: Response Get Audience Category Campaign All Adgroups Reporting Audience Category Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/category/campaign/{campaign_id}/creatives: get: tags: - Reporting summary: Get Audience Category Campaign Creatives description: Gets audience category metrics for all creatives in a specific campaign. operationId: get_audience_category_campaign_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceCategoryCreativeFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 1 title: Min Imp Count description: Minimum impression count filter - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceCategoryCampaignCreativesModel' title: Response Get Audience Category Campaign Creatives Reporting Audience Category Campaign Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/category/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Audience Category Adgroup description: Gets audience category metrics for a specific adgroup. operationId: get_audience_category_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceCategoryAdgroupFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer minimum: 1 description: Minimum impression count filter default: 1 title: Min Imp Count description: Minimum impression count filter - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceCategoryAdgroupModel' title: Response Get Audience Category Adgroup Reporting Audience Category Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/category/creative/{creative_id}: get: tags: - Reporting summary: Get Audience Category Creative description: Gets audience category metrics for a specific creative. operationId: get_audience_category_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceCategoryCreativeFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: type: integer description: Minimum impression count filter default: 1 title: Min Imp Count description: Minimum impression count filter - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceCategoryCreativeModel' title: Response Get Audience Category Creative Reporting Audience Category Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/v1/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audience V1 Breakdown Campaign description: Gets audience breakdown metrics for a specific campaign. (Old Taxonomy) operationId: get_audience_v1_breakdown_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: key in: query required: true schema: $ref: '#/components/schemas/AudienceBreakdownV1Key' description: 1 for brand, 2 for category description: 1 for brand, 2 for category - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean default: false title: All Adgroups - name: all_creatives in: query required: false schema: type: boolean default: false title: All Creatives - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBreakdownV1CampaignResponseModel' title: Response Get Audience V1 Breakdown Campaign Reporting Audience V1 Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/v1/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Audience V1 Breakdown Adgroup description: Gets audience breakdown metrics for a specific ad group. (Old Taxonomy) operationId: get_audience_v1_breakdown_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: key in: query required: true schema: $ref: '#/components/schemas/AudienceBreakdownV1Key' description: 1 for brand, 2 for category description: 1 for brand, 2 for category - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_creatives in: query required: false schema: type: boolean default: false title: All Creatives - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBreakdownV1AdgroupResponseModel' title: Response Get Audience V1 Breakdown Adgroup Reporting Audience V1 Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/v1/creative/{creative_id}: get: tags: - Reporting summary: Get Audience V1 Breakdown Creative description: Gets audience breakdown metrics for a specific creative. (Old Taxonomy) operationId: get_audience_v1_breakdown_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: key in: query required: true schema: $ref: '#/components/schemas/AudienceBreakdownV1Key' description: 1 for brand, 2 for category description: 1 for brand, 2 for category - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBreakdownV1CreativeResponseModel' title: Response Get Audience V1 Breakdown Creative Reporting Audience V1 Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/behavioral/campaigns/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Audience Behavioral Campaign Adgroups description: Gets behavioral audience (bhaud) metrics for all adgroups in a campaign. operationId: get_audience_behavioral_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: type: string description: 'Sort by: imp, clks, spend, ctr' default: imp title: Sort By description: 'Sort by: imp, clks, spend, ctr' - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBreakdownCampaignResponseModel' title: Response Get Audience Behavioral Campaign Adgroups Reporting Audience Behavioral Campaigns Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/behavioral/campaigns/{campaign_id}/creatives: get: tags: - Reporting summary: Get Audience Behavioral Campaign Creatives description: Gets behavioral audience (bhaud) metrics for all creatives in a campaign. operationId: get_audience_behavioral_campaign_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceBehavioralSortByFieldName' description: 'Sort by: imp, clks, sa, ctr, vr' default: vr description: 'Sort by: imp, clks, sa, ctr, vr' - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: min_imp_count in: query required: false schema: anyOf: - type: integer minimum: 0 - type: 'null' description: Minimum impressions filter title: Min Imp Count description: Minimum impressions filter - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBehavioralCreativeResponseModel' title: Response Get Audience Behavioral Campaign Creatives Reporting Audience Behavioral Campaigns Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/v2/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audience V2 Breakdown Campaign description: Gets audience breakdown metrics for a specific campaign. (New Taxonomy) operationId: get_audience_v2_breakdown_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean default: false title: All Adgroups - name: all_creatives in: query required: false schema: type: boolean default: false title: All Creatives - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBreakdownCampaignResponseModel' title: Response Get Audience V2 Breakdown Campaign Reporting Audience V2 Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/v2/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Audience V2 Breakdown Adgroup description: Gets audience breakdown metrics for a specific ad group. (New Taxonomy) operationId: get_audience_v2_breakdown_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_creatives in: query required: false schema: type: boolean default: false title: All Creatives - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBreakdownAdgroupResponseModel' title: Response Get Audience V2 Breakdown Adgroup Reporting Audience V2 Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/behavioral/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Audience Behavioral Adgroup description: Gets behavioral audience (bhaud) metrics for a specific ad group (Rocket full + chart consolidated). operationId: get_audience_behavioral_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_creatives in: query required: false schema: type: boolean description: When true, returns metrics grouped by creative in addition to behavioral segment. default: false title: All Creatives description: When true, returns metrics grouped by creative in addition to behavioral segment. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBreakdownAdgroupResponseModel' title: Response Get Audience Behavioral Adgroup Reporting Audience Behavioral Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/behavioral/creative/{creative_id}: get: tags: - Reporting summary: Get Audience Behavioral Creative description: Gets behavioral audience (bhaud) metrics for a specific creative (Rocket AUDIENCE_INSIGHTS_BHAUD_CREATIVE). operationId: get_audience_behavioral_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudienceBehavioralSortByFieldName' description: 'Sort by field: imp, clks, sa, ctr, vr.' default: imp description: 'Sort by field: imp, clks, sa, ctr, vr.' - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Maximum number of records. title: Limit description: Maximum number of records. - name: min_imp_count in: query required: false schema: anyOf: - type: integer minimum: 0 - type: 'null' description: Minimum impression count per segment (0 to include all; omit for default 5000). title: Min Imp Count description: Minimum impression count per segment (0 to include all; omit for default 5000). - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBehavioralCreativeResponseModel' title: Response Get Audience Behavioral Creative Reporting Audience Behavioral Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/segments/behavioral/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Audience Segments Behavioral Adgroup description: Gets behavioral segment (bhaud) breakdown for an ad group (Rocket BhaudBreakdownByAdgroup). operationId: get_audience_segments_behavioral_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: bhaud in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter to a single matched_baud / behavioral segment (backend key). title: Bhaud description: Filter to a single matched_baud / behavioral segment (backend key). - name: sort_by in: query required: false schema: type: string description: 'Sort by field: imp, clks, spend, ctr.' default: imp title: Sort By description: 'Sort by field: imp, clks, spend, ctr.' - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Maximum number of records. title: Limit description: Maximum number of records. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBreakdownAdgroupResponseModel' title: Response Get Audience Segments Behavioral Adgroup Reporting Audience Segments Behavioral Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/segments/behavioral/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audience Segments Behavioral Campaign description: Gets behavioral segment (bhaud) breakdown for a campaign (Rocket BhaudBreakdownByCampaign). operationId: get_audience_segments_behavioral_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: bhaud in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter to a single matched_baud / behavioral segment (backend key). title: Bhaud description: Filter to a single matched_baud / behavioral segment (backend key). - name: all_adgroups in: query required: false schema: type: boolean description: When true, breaks down by ad group plus segment (Rocket all_adgroups). default: false title: All Adgroups description: When true, breaks down by ad group plus segment (Rocket all_adgroups). - name: sort_by in: query required: false schema: type: string description: 'Sort by field: imp, clks, spend, ctr.' default: imp title: Sort By description: 'Sort by field: imp, clks, spend, ctr.' - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Maximum number of records. title: Limit description: Maximum number of records. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBreakdownCampaignResponseModel' title: Response Get Audience Segments Behavioral Campaign Reporting Audience Segments Behavioral Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/behavioral/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audience Behavioral Campaign description: Gets behavioral audience (bhaud) metrics for a specific campaign (Rocket full + chart + export consolidated). operationId: get_audience_behavioral_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean description: When true, returns metrics grouped by ad group in addition to behavioral segment. default: false title: All Adgroups description: When true, returns metrics grouped by ad group in addition to behavioral segment. - name: sort_by in: query required: false schema: type: string description: 'Sort by field: imp, clks, spend, ctr.' default: imp title: Sort By description: 'Sort by field: imp, clks, spend, ctr.' - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Maximum number of records (export). title: Limit description: Maximum number of records (export). - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBreakdownCampaignResponseModel' title: Response Get Audience Behavioral Campaign Reporting Audience Behavioral Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audience/v2/creative/{creative_id}: get: tags: - Reporting summary: Get Audience V2 Breakdown Creative description: Gets audience breakdown metrics for a specific creative. (New Taxonomy) operationId: get_audience_v2_breakdown_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudienceBreakdownCreativeResponseModel' title: Response Get Audience V2 Breakdown Creative Reporting Audience V2 Creative Creative Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/conversion_tracking/account/{account_id}: get: tags: - Reporting summary: Get Conversion Tracking Account description: Gets multipixel conversion metrics aggregated across all campaigns in an account. operationId: get_conversion_tracking_account security: - api-key: [] - user-id: [] - session: [] parameters: - name: account_id in: path required: true schema: type: integer title: Account Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/PixelCampaignFieldName' description: Sort by field default: conversions description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: pixel_ids in: query required: false schema: anyOf: - type: string - type: 'null' description: Comma-separated list of pixel IDs title: Pixel Ids description: Comma-separated list of pixel IDs responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/PixelConversionModel' title: Response Get Conversion Tracking Account Reporting Conversion Tracking Account Account Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/pixel/campaign/{campaign_id}: get: tags: - Reporting summary: Get Pixel Campaign description: Gets multipixel conversions data for a specific campaign. operationId: get_pixel_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/PixelCampaignFieldName' description: Sort by field default: conversions description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: pixel_ids in: query required: false schema: anyOf: - type: string - type: 'null' description: Comma-separated list of pixel IDs title: Pixel Ids description: Comma-separated list of pixel IDs responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/PixelConversionModel' title: Response Get Pixel Campaign Reporting Pixel Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/pixel/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Pixel Adgroup description: Gets multipixel conversions export for a specific adgroup. operationId: get_pixel_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/PixelConversionModel' title: Response Get Pixel Adgroup Reporting Pixel Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/spend/campaign/{campaign_id}: get: tags: - Reporting summary: Get Campaign Spend description: Gets total up-to-date spend for a campaign. operationId: get_campaign_spend security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CampaignSpendModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/spend/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Adgroup Spend description: Gets total up-to-date spend for an ad group. operationId: get_adgroup_spend security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AdgroupSpendModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/marketshare/campaign/{campaign_id}: get: tags: - Reporting summary: Get Marketshare Campaign description: Gets market share data for a specific campaign. operationId: get_marketshare_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MarketShareCampaignModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/podcast_ad_position/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audio Podcast Ad Position Campaign description: Gets audio podcast ad position metrics for a specific campaign. operationId: get_audio_podcast_ad_position_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioPodcastAdPositionCampaignModel' title: Response Get Audio Podcast Ad Position Campaign Reporting Audio Podcast Ad Position Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/podcast_ad_position/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Audio Podcast Ad Position Campaign Adgroups description: Gets audio podcast ad position metrics for all ad groups in a specific campaign. operationId: get_audio_podcast_ad_position_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioPodcastAdPositionCampaignAdgroupsModel' title: Response Get Audio Podcast Ad Position Campaign Adgroups Reporting Audio Podcast Ad Position Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/streaming_genre/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audio Streaming Genre Campaign description: Gets audio streaming genre metrics for a specific campaign. operationId: get_audio_streaming_genre_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudioPodcastFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioStreamingGenreCampaignModel' title: Response Get Audio Streaming Genre Campaign Reporting Audio Streaming Genre Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/streaming_genre/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Audio Streaming Genre Adgroup description: Gets audio streaming genre metrics for a specific adgroup. operationId: get_audio_streaming_genre_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudioPodcastFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioStreamingGenreAdgroupModel' title: Response Get Audio Streaming Genre Adgroup Reporting Audio Streaming Genre Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/streaming_genre/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Audio Streaming Genre Campaign Adgroups description: Gets audio streaming genre metrics for all adgroups in a specific campaign. operationId: get_audio_streaming_genre_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudioPodcastFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioStreamingGenreCampaignAllAdgroupsModel' title: Response Get Audio Streaming Genre Campaign Adgroups Reporting Audio Streaming Genre Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/daily/campaign/{campaign_id}: get: tags: - Reporting summary: Get Daily Metrics Campaign description: Gets timeseries daily trend metrics for a specific campaign. operationId: get_daily_metrics_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetDailyMetricsCampaignResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/publisher/campaign/{campaign_id}: get: tags: - Reporting summary: Get Audio Publisher Campaign description: Gets audio publisher metrics for a specific campaign. operationId: get_audio_publisher_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudioPodcastFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioPublisherCampaignModel' title: Response Get Audio Publisher Campaign Reporting Audio Publisher Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/publisher/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Audio Publisher Adgroup description: Gets audio publisher metrics for a specific adgroup. operationId: get_audio_publisher_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudioPodcastFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioPublisherAdgroupModel' title: Response Get Audio Publisher Adgroup Reporting Audio Publisher Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/audio/publisher/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Audio Publisher Campaign All Adgroups description: Gets audio publisher metrics for all ad groups in a specific campaign. operationId: get_audio_publisher_campaign_all_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/AudioPodcastFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AudioPublisherCampaignAllAdgroupsModel' title: Response Get Audio Publisher Campaign All Adgroups Reporting Audio Publisher Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/daily/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Daily Metrics Adgroup description: Gets timeseries daily trend metrics for a specific ad group. operationId: get_daily_metrics_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetDailyMetricsAdgroupResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/daily/creative/{creative_id}: get: tags: - Reporting summary: Get Daily Metrics Creative description: Gets timeseries daily trend metrics for a specific creative. operationId: get_daily_metrics_creative security: - api-key: [] - user-id: [] - session: [] parameters: - name: creative_id in: path required: true schema: type: integer title: Creative Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetDailyMetricsCreativeResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/publisher/v2/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Ctv Publisher Adgroup description: Gets CTV publisher metrics for a specific ad group. operationId: get_ctv_publisher_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/CtvOttCampaignSortByFieldName' default: impressions - name: limit in: query required: false schema: type: integer minimum: 1 default: 10 title: Limit - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/CtvPublisherAdgroupModel' title: Response Get Ctv Publisher Adgroup Reporting Publisher V2 Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/publisher/v2/campaign/{campaign_id}: get: tags: - Reporting summary: Get Ctv Publisher Campaign description: Gets CTV publisher metrics for a specific campaign. operationId: get_ctv_publisher_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/CtvOttCampaignSortByFieldName' default: impressions - name: limit in: query required: false schema: type: integer minimum: 1 default: 10 title: Limit - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/CtvPublisherAdgroupModel' title: Response Get Ctv Publisher Campaign Reporting Publisher V2 Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/ctv_ott/publisher/campaigns/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Ctv Publisher Campaign Adgroups description: Gets CTV/OTT publisher metrics for all ad groups in a campaign. operationId: get_ctv_publisher_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/CtvOttCampaignSortByFieldName' default: impressions - name: limit in: query required: false schema: anyOf: - type: integer - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/CtvPublisherCampaignAdgroupsModel' title: Response Get Ctv Publisher Campaign Adgroups Reporting Ctv Ott Publisher Campaigns Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/ctv_ott/network/campaign/{campaign_id}: get: tags: - Reporting summary: Get Ctv Network Campaign description: Gets CTV/OTT network bundle metrics for a campaign (unified full/partial/export). operationId: get_ctv_network_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/CtvNetworkSortByFieldName' default: imp - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/CtvNetworkRowModel' title: Response Get Ctv Network Campaign Reporting Ctv Ott Network Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/ctv_ott/network/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Ctv Network Campaign Adgroups description: Gets CTV/OTT network bundle metrics per ad group for a campaign. operationId: get_ctv_network_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/CtvNetworkSortByFieldName' default: imp - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/CtvNetworkRowModel' title: Response Get Ctv Network Campaign Adgroups Reporting Ctv Ott Network Campaign Campaign Id Adgroups Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/ctv_ott/network/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Ctv Network Adgroup description: Gets CTV/OTT network bundle metrics for an ad group. operationId: get_ctv_network_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: sort_by in: query required: false schema: $ref: '#/components/schemas/CtvNetworkSortByFieldName' default: imp - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/CtvNetworkRowModel' title: Response Get Ctv Network Adgroup Reporting Ctv Ott Network Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/daily/campaign/{campaign_id}/adgroups: get: tags: - Reporting summary: Get Daily Metrics Campaign Adgroups description: Gets timeseries daily trend metrics for all ad groups in a specific campaign. operationId: get_daily_metrics_campaign_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DailyMetricsCampaignAdgroupsResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/daily/campaign/{campaign_id}/creatives: get: tags: - Reporting summary: Get Daily Metrics Campaign Creatives description: Gets timeseries daily trend metrics for all creatives in a specific campaign. operationId: get_daily_metrics_campaign_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DailyMetricsCampaignCreativesModel' title: Response Get Daily Metrics Campaign Creatives Reporting Daily Campaign Campaign Id Creatives Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/dooh/v1/campaign/{campaign_id}: get: tags: - Reporting summary: Get Dooh Campaign V1 description: Retrieves DOOH campaign performance grouped by requested dimensions. Supported dimensions include publisher, venue_type, state, county, dma, zip, ad_group, creative, and ad_unit_id. operationId: get_dooh_campaign_v1 security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: Opaque cursor returned in `pagination.next_cursor`. title: Cursor description: Opaque cursor returned in `pagination.next_cursor`. - name: page_size in: query required: false schema: type: integer maximum: 1000 minimum: 1 description: Number of rows per page (max 1000). default: 100 title: Page Size description: Number of rows per page (max 1000). - name: limit in: query required: false schema: anyOf: - type: integer maximum: 1000 minimum: 1 - type: 'null' description: Alias for page_size. title: Limit description: Alias for page_size. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: dimensions in: query required: true schema: type: string description: Comma-separated list of dimensions to slice the campaign performance by. Order is preserved and duplicates collapsed.

Available values:
- publisher
- venue_type
- ad_group
- creative
- state
- dma
- county
- zip
- ad_unit_id title: Dimensions description: Comma-separated list of dimensions to slice the campaign performance by. Order is preserved and duplicates collapsed.

Available values:
- publisher
- venue_type
- ad_group
- creative
- state
- dma
- county
- zip
- ad_unit_id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DoohCampaignV1ResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/dooh/publisher/campaign/{campaign_id}: get: tags: - Reporting summary: Get Dooh Publisher Campaign description: Gets DOOH publisher metrics for a specific campaign. operationId: get_dooh_publisher_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean description: When true, breaks out results by ad group. default: false title: All Adgroups description: When true, breaks out results by ad group. - name: all_creatives in: query required: false schema: type: boolean description: When true, breaks out results by creative. default: false title: All Creatives description: When true, breaks out results by creative. - name: sort_by in: query required: false schema: $ref: '#/components/schemas/DoohPublisherCampaignSortByFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DoohPublisherCampaignResponseModel' title: Response Get Dooh Publisher Campaign Reporting Dooh Publisher Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/banner/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Banner Size Breakdown Adgroup description: Gets banner-size breakdown metrics for a specific ad group, optionally split by creative. operationId: get_banner_size_breakdown_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_creatives in: query required: false schema: type: boolean description: When true, breaks out results by creative. default: false title: All Creatives description: When true, breaks out results by creative. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/BannerSizeBreakdownAdgroupModel' title: Response Get Banner Size Breakdown Adgroup Reporting Banner Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/banner/campaign/{campaign_id}: get: tags: - Reporting summary: Get Banner Size Breakdown Campaign description: Gets banner-size breakdown metrics for a specific campaign, optionally split by ad group or creative. operationId: get_banner_size_breakdown_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean description: When true, breaks out results by ad group. default: false title: All Adgroups description: When true, breaks out results by ad group. - name: all_creatives in: query required: false schema: type: boolean description: When true, breaks out results by creative. default: false title: All Creatives description: When true, breaks out results by creative. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/BannerSizeBreakdownCampaignModel' title: Response Get Banner Size Breakdown Campaign Reporting Banner Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/dooh/venue_type/campaign/{campaign_id}: get: tags: - Reporting summary: Get Dooh Venue Type Campaign description: Gets DOOH venue type metrics for a specific campaign. operationId: get_dooh_venue_type_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: Start Date description: Date should be in YYYY-MM-DD - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Date should be in YYYY-MM-DD title: End Date description: Date should be in YYYY-MM-DD - name: all_adgroups in: query required: false schema: type: boolean description: When true, breaks out results by ad group. default: false title: All Adgroups description: When true, breaks out results by ad group. - name: all_creatives in: query required: false schema: type: boolean description: When true, breaks out results by creative. default: false title: All Creatives description: When true, breaks out results by creative. - name: sort_by in: query required: false schema: $ref: '#/components/schemas/DoohVenueTypeCampaignSortByFieldName' description: Sort by field default: imp description: Sort by field - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 - type: 'null' description: Limit number of records title: Limit description: Limit number of records - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DoohVenueTypeCampaignModel' title: Response Get Dooh Venue Type Campaign Reporting Dooh Venue Type Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/web_engagement/campaign/{campaign_id}: get: tags: - Reporting summary: Get Web Engagement Campaign description: Gets daily trend web engagement metrics for a specific campaign. operationId: get_web_engagement_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Start date (YYYY-MM-DD). Must be provided with end_date. title: Start Date description: Start date (YYYY-MM-DD). Must be provided with end_date. - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: End date (YYYY-MM-DD). Must be provided with start_date. title: End Date description: End date (YYYY-MM-DD). Must be provided with start_date. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/WebEngagementCampaignResponseModel' title: Response Get Web Engagement Campaign Reporting Web Engagement Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/web_engagement/totals/campaign/{campaign_id}: get: tags: - Reporting summary: Get Web Engagement Totals Campaign description: Gets totals / cumulative web engagement metrics for a specific campaign. operationId: get_web_engagement_totals_campaign security: - api-key: [] - user-id: [] - session: [] parameters: - name: campaign_id in: path required: true schema: type: integer title: Campaign Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Start date (YYYY-MM-DD). Must be provided with end_date. title: Start Date description: Start date (YYYY-MM-DD). Must be provided with end_date. - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: End date (YYYY-MM-DD). Must be provided with start_date. title: End Date description: End date (YYYY-MM-DD). Must be provided with start_date. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/WebEngagementTotalsCampaignResponseModel' title: Response Get Web Engagement Totals Campaign Reporting Web Engagement Totals Campaign Campaign Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/web_engagement/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Web Engagement Adgroup description: Gets daily trend web engagement metrics for a specific ad group. operationId: get_web_engagement_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Start date (YYYY-MM-DD). To override defaults, provide both start_date and end_date. title: Start Date description: Start date (YYYY-MM-DD). To override defaults, provide both start_date and end_date. - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: End date (YYYY-MM-DD). To override defaults, provide both start_date and end_date. title: End Date description: End date (YYYY-MM-DD). To override defaults, provide both start_date and end_date. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/WebEngagementAdgroupResponseModel' title: Response Get Web Engagement Adgroup Reporting Web Engagement Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /reporting/web_engagement/totals/adgroup/{adgroup_id}: get: tags: - Reporting summary: Get Web Engagement Totals Adgroup description: Gets totals / cumulative web engagement metrics for a specific ad group. operationId: get_web_engagement_totals_adgroup security: - api-key: [] - user-id: [] - session: [] parameters: - name: adgroup_id in: path required: true schema: type: integer title: Adgroup Id - name: start_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Start date (YYYY-MM-DD). To override defaults, provide both start_date and end_date. title: Start Date description: Start date (YYYY-MM-DD). To override defaults, provide both start_date and end_date. - name: end_date in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: End date (YYYY-MM-DD). To override defaults, provide both start_date and end_date. title: End Date description: End date (YYYY-MM-DD). To override defaults, provide both start_date and end_date. - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/WebEngagementTotalsAdgroupResponseModel' title: Response Get Web Engagement Totals Adgroup Reporting Web Engagement Totals Adgroup Adgroup Id Get '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/tenants: post: tags: - Search summary: Search Tenants description: Searches tenants operationId: search_tenants requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchTenantsResultsModel' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' security: - api-key: [] - user-id: [] - session: [] /search/organizations: post: tags: - Search summary: Search Organizations description: Searches organizations operationId: search_organizations security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: false schema: anyOf: - type: integer - type: 'null' title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchOrganizationsResultsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/accounts: post: tags: - Search summary: Search Accounts description: Searches accounts operationId: search_accounts security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: false schema: anyOf: - type: integer - type: 'null' title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchAccountsRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchAccountsResultsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/campaigns: post: tags: - Search summary: Search Campaigns description: Searches campaigns operationId: search_campaigns security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: false schema: anyOf: - type: integer - type: 'null' title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchCampaignsRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchCampaignsResultsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/adgroups: post: tags: - Search summary: Search Adgroups description: Searches ad groups operationId: search_adgroups security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: false schema: anyOf: - type: integer - type: 'null' title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchAdgroupsRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchAdgroupsResultsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/creatives: post: tags: - Search summary: Search Creatives description: Searches creatives operationId: search_creatives security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: false schema: anyOf: - type: integer - type: 'null' title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchCreativesRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchCreativesResultsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/location_filters: post: tags: - Search summary: Search Location Filters description: Searches location filters operationId: search_location_filters requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchLocationFiltersRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchLocationFiltersResultsModel' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' security: - api-key: [] - user-id: [] - session: [] /search/audiences: post: tags: - Search summary: Search Audiences description: Searches audiences operationId: search_audiences security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchAudiencesRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchAudiencesResultsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/neighborhoods: post: tags: - Search summary: Search Neighborhoods description: Searches neighborhoods (behaviors, brands, categories, and location groups) operationId: search_neighborhoods security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchNeighborhoodsRequestModel' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/NeighborhoodSearchResult' title: Response Search Neighborhoods Search Neighborhoods Post '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/on_premise_locations: post: tags: - Search summary: Search On Premise Locations description: Searches on premise brands, categories, and location groups operationId: search_on_premise_locations security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchOnPremiseLocationsRequestModel' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/OnPremiseLocationSearchResult' title: Response Search On Premise Locations Search On Premise Locations Post '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/drive_to_locations: post: tags: - Search summary: Search Drive To Locations description: Searches drive-to locations (brands and location groups) operationId: search_drive_to_locations security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchDriveToLocationsRequestModel' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DriveToLocationsSearchResult' title: Response Search Drive To Locations Search Drive To Locations Post '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/location_groups: post: tags: - Search summary: Search Location Groups description: Searches location groups for audience targeting operationId: search_location_groups security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchLocationGroupsRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchLocationGroupsResultsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/ad_packages: post: tags: - Search summary: Search Ad Packages description: Searches ad packages operationId: search_ad_packages security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: campaign_id in: query required: true schema: type: integer title: Campaign Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchAdPackagesResultsModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/location_groups/sources: post: tags: - Search summary: Search Pois Sources description: Searches sources to add to a location group operationId: search_pois_sources security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchPOISourcesResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/location_groups/sources/count: post: tags: - Search summary: Search Pois Sources Count description: Returns counts for requested sources operationId: search_pois_sources_count security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchPOISourcesRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchPOISourcesCountResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/location_groups/sources/pois: post: tags: - Search summary: Search Pois Sources Preview Pois description: Searches POIs given requested sources operationId: search_pois_sources_preview_pois security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchPOISourcesPreviewPOIsRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchPOISourcesPreviewResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/location_groups/location_filters: post: tags: - Search summary: Search Pois Location Filters description: Searches location filters for a location group operationId: search_pois_location_filters security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchPOIsLocationFiltersResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /search/location_groups/pois: post: tags: - Search summary: Search Location Group Pois description: Searches POIs and addresses by business name and/or address operationId: search_location_group_pois security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchLocationGroupPOIsRequestModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SearchLocationGroupPOIsResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /static/account_verticals: get: tags: - Static summary: Get Account Verticals description: Gets all account verticals operationId: get_account_verticals responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AccountVerticalsModel' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' /static/audio/podcast_topics: get: tags: - Static summary: Get Audio Podcast Topics description: Gets all targetable audio podcast topics operationId: get_audio_podcast_topics responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AudioPodcastTopicsModel' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' /static/audio/streaming_genres: get: tags: - Static summary: Get Audio Streaming Genres description: Gets all targetable audio streaming genres operationId: get_audio_streaming_genres responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AudioStreamingGenresModel' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' /static/mobile_carriers: get: tags: - Static summary: Get Carriers description: Gets all targetable carriers for your account's country operationId: get_carriers security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MobileCarriersModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /static/cities: get: tags: - Static summary: Get Cities description: Gets all targetable cities for your account's country operationId: get_cities security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CitiesModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /static/streaming_video/content_categories: get: tags: - Static summary: Get Streaming Video Content Categories description: Gets all targetable streaming video content categories operationId: get_streaming_video_content_categories responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StreamingVideoContentCategoriesModel' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' /static/streaming_video/premium_ctv_categories: get: tags: - Static summary: Get Streaming Video Premium Ctv Categories description: Gets all targetable CTV premium categories operationId: get_streaming_video_premium_ctv_categories responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CTVPremiumCategoriesModel' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' /static/dmas: get: tags: - Static summary: Get Dmas description: Gets all targetable DMAs operationId: get_dmas responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DMAsModel' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' /static/publisher_categories: get: tags: - Static summary: Get Publisher Categories description: Gets all targetable publisher categories operationId: get_publisher_categories responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PublisherCategoriesModel' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' /static/states: get: tags: - Static summary: Get States description: Gets all targetable states for your account's country operationId: get_states security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: account_id in: query required: true schema: type: integer title: Account Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StatesModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /static/iab_categories: get: tags: - Static summary: Get Iab Categories description: Gets IAB categories operationId: get_iab_categories parameters: - name: search in: query required: false schema: type: string description: Search IAB categories based on name or category default: '' title: Search description: Search IAB categories based on name or category responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/IABCategoriesResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /static/publishers: get: tags: - Static summary: Get Publishers description: Gets available publishers for a campaign operationId: get_publishers security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id - name: campaign_id in: query required: true schema: type: integer title: Campaign Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PublishersModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /tenants/{tenant_id}: get: tags: - Tenants summary: Get Tenant description: Gets a tenant operationId: get_tenant security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: path required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TenantModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error put: tags: - Tenants summary: Update Tenant description: Updates a tenant operationId: update_tenant security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: path required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateTenantModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TenantModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /upload: post: tags: - Upload summary: Upload description: Uploads a file and returns a URL operationId: upload security: - api-key: [] - user-id: [] - session: [] parameters: - name: upload_type in: query required: true schema: $ref: '#/components/schemas/UploadType' requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/Body_upload_upload_post' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UploadResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /users/signup: post: tags: - Users summary: Signup description: Creates a new user, tenant, organization, and account operationId: signup parameters: - name: utm_source in: query required: false schema: anyOf: - type: string - type: 'null' title: Utm Source - name: utm_medium in: query required: false schema: anyOf: - type: string - type: 'null' title: Utm Medium - name: utm_campaign in: query required: false schema: anyOf: - type: string - type: 'null' title: Utm Campaign requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignupModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SignupResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /users/current: get: tags: - Users summary: Get Current User description: Gets the current user operationId: get_current_user responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UserModel' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' security: - api-key: [] - user-id: [] - session: [] /users/{user_id}: get: tags: - Users summary: Get User description: Gets a user operationId: get_user security: - api-key: [] - user-id: [] - session: [] parameters: - name: user_id in: path required: true schema: type: integer title: User Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UserModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error delete: tags: - Users summary: Delete User description: Deletes a user operationId: delete_user security: - api-key: [] - user-id: [] - session: [] parameters: - name: user_id in: path required: true schema: type: integer title: User Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SuccessResponseModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error put: tags: - Users summary: Update User description: Updates a user operationId: update_user security: - api-key: [] - user-id: [] - session: [] parameters: - name: user_id in: path required: true schema: type: integer title: User Id - name: tenant_id in: query required: true schema: type: integer title: Tenant Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateUserModel' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UserModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /users: get: tags: - Users summary: Get Users description: Gets users under a tenant operationId: get_users security: - api-key: [] - user-id: [] - session: [] parameters: - name: tenant_id in: query required: true schema: type: integer title: Tenant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UsersModel' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' description: Internal Server Error /version: get: tags: - Miscellaneous summary: Get Version description: Gets the current API version operationId: get_version responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VersionModel' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponseModel' components: schemas: AccountMinCPVBidRateModel: properties: min_bid_rate: type: number title: Min Bid Rate type: object required: - min_bid_rate title: AccountMinCPVBidRateModel AccountModel: properties: id: type: integer title: Id tenant_id: type: integer title: Tenant Id organization_id: type: integer title: Organization Id name: type: string title: Name country_code: $ref: '#/components/schemas/CountryCode' timezone: $ref: '#/components/schemas/Timezone' currency: $ref: '#/components/schemas/Currency' type: $ref: '#/components/schemas/AccountType' website_domain: type: string title: Website Domain brand_id: anyOf: - type: integer - type: 'null' title: Brand Id vertical_id: anyOf: - $ref: '#/components/schemas/AccountVertical' - type: 'null' dart_billing_account: anyOf: - $ref: '#/components/schemas/DartBillingAccount' - type: 'null' updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date created_date: type: string format: date-time title: Created Date type: object required: - id - tenant_id - organization_id - name - country_code - timezone - currency - type - website_domain - brand_id - created_date title: AccountModel AccountPixelModel: properties: id: type: integer title: Id tenant_id: type: integer title: Tenant Id organization_id: type: integer title: Organization Id account_id: type: integer title: Account Id name: type: string title: Name url: type: string title: Url segment_id: anyOf: - type: integer - type: 'null' title: Segment Id updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date website_url: type: string title: Website Url hashcode: anyOf: - type: string - type: 'null' title: Hashcode type: object required: - id - tenant_id - organization_id - account_id - name - url - website_url title: AccountPixelModel AccountPixelsModel: properties: total_count: type: integer title: Total Count limit: type: integer title: Limit page_num: type: integer title: Page Num total_pages: type: integer title: Total Pages has_next_page: type: boolean title: Has Next Page has_prev_page: type: boolean title: Has Prev Page items: items: $ref: '#/components/schemas/AccountPixelModel' type: array title: Items type: object required: - total_count - limit - page_num - total_pages - has_next_page - has_prev_page - items title: AccountPixelsModel AccountSearchResult: properties: id: type: integer title: Id name: type: string title: Name created_date: anyOf: - type: string format: date-time - type: 'null' title: Created Date tenant_id: type: integer title: Tenant Id tenant_name: type: string title: Tenant Name organization_id: type: integer title: Organization Id organization_name: type: string title: Organization Name type: object required: - id - name - created_date - tenant_id - tenant_name - organization_id - organization_name title: AccountSearchResult AccountType: oneOf: - const: 0 title: DIRECT_CLIENT - const: 1 title: DIRECT_AGENCY - const: 2 title: PLATFORM_CMR - const: 3 title: PLATFORM_RESELLER - const: 4 title: PLATFORM_CHANNEL - const: 5 title: DIRECT_PROGRAMMATIC - const: 6 title: PLATFORM_PROGRAMMATIC - const: 7 title: PROGRAMMATIC - const: 8 title: SELF_SERVE - const: 9 title: CHARITY type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 title: AccountType x-enum-varnames: - DIRECT_CLIENT - DIRECT_AGENCY - PLATFORM_CMR - PLATFORM_RESELLER - PLATFORM_CHANNEL - DIRECT_PROGRAMMATIC - PLATFORM_PROGRAMMATIC - PROGRAMMATIC - SELF_SERVE - CHARITY AccountVertical: oneOf: - const: 1 title: AUTOMOTIVE - const: 2 title: CPG - const: 3 title: ECOMMERCE - const: 4 title: FINANCIAL_SERVICES - const: 5 title: GOVERNMENT_POLITICAL - const: 6 title: HEALTH - const: 7 title: INDUSTRIAL_UTILITIES - const: 8 title: MEDIA_AND_ENTERTAINMENT - const: 9 title: RESTAURANTS - const: 10 title: RETAIL - const: 11 title: SERVICES - const: 12 title: TECHNOLOGY - const: 13 title: TELECOM_AND_COMMUNICATIONS - const: 14 title: TRAVEL type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 title: AccountVertical x-enum-varnames: - AUTOMOTIVE - CPG - ECOMMERCE - FINANCIAL_SERVICES - GOVERNMENT_POLITICAL - HEALTH - INDUSTRIAL_UTILITIES - MEDIA_AND_ENTERTAINMENT - RESTAURANTS - RETAIL - SERVICES - TECHNOLOGY - TELECOM_AND_COMMUNICATIONS - TRAVEL AccountVerticalModel: properties: id: type: integer title: Id name: type: string title: Name type: object required: - id - name title: AccountVerticalModel AccountVerticalsModel: properties: items: items: $ref: '#/components/schemas/AccountVerticalModel' type: array title: Items type: object required: - items title: AccountVerticalsModel AccountsModel: properties: total_count: type: integer title: Total Count limit: type: integer title: Limit page_num: type: integer title: Page Num total_pages: type: integer title: Total Pages has_next_page: type: boolean title: Has Next Page has_prev_page: type: boolean title: Has Prev Page items: items: $ref: '#/components/schemas/AccountModel' type: array title: Items type: object required: - total_count - limit - page_num - total_pages - has_next_page - has_prev_page - items title: AccountsModel AdPackageModel: properties: id: type: integer title: Id name: type: string title: Name type: object required: - id - name title: AdPackageModel AdPackageSearchResult: properties: id: type: integer title: Id name: type: string title: Name type: object required: - id - name title: AdPackageSearchResult AdgroupAvailsResponse: properties: audience_reach: type: integer title: Audience Reach audience_reach_low: type: integer title: Audience Reach Low audience_reach_high: type: integer title: Audience Reach High daily_available_impressions: type: integer title: Daily Available Impressions daily_available_impressions_low: type: integer title: Daily Available Impressions Low daily_available_impressions_high: type: integer title: Daily Available Impressions High daily_budgeted_impressions: anyOf: - type: integer - type: 'null' title: Daily Budgeted Impressions deliverability: anyOf: - type: string enum: - Fair - Good - Poor - type: 'null' title: Deliverability deliverability_ratio: type: number title: Deliverability Ratio type: object required: - audience_reach - audience_reach_low - audience_reach_high - daily_available_impressions - daily_available_impressions_low - daily_available_impressions_high - deliverability - deliverability_ratio title: AdgroupAvailsResponse AdgroupModel: properties: id: type: integer title: Id tenant_id: type: integer title: Tenant Id organization_id: type: integer title: Organization Id account_id: type: integer title: Account Id campaign_id: type: integer title: Campaign Id name: type: string title: Name start_date: type: string format: date title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date status: type: integer enum: - 2 - 1 title: Status objective: anyOf: - $ref: '#/components/schemas/Objective' - type: 'null' tactic: anyOf: - $ref: '#/components/schemas/TargetingTactic' - type: 'null' media_types: items: $ref: '#/components/schemas/MediaType' type: array title: Media Types bid_type: $ref: '#/components/schemas/app__api__routes__constants__BidType' bid_price: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Bid Price budgets: items: $ref: '#/components/schemas/BudgetModel-Output' type: array title: Budgets gross_budget: anyOf: - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Gross Budget budget_type: $ref: '#/components/schemas/BudgetType' audiences: items: $ref: '#/components/schemas/AudienceModel' type: array title: Audiences lookalike_audience_scale: anyOf: - $ref: '#/components/schemas/LookalikeAudienceScale' - type: 'null' deprecated: true location_filters: items: $ref: '#/components/schemas/LocationFilterModel-Output' type: array title: Location Filters drive_to_locations: items: $ref: '#/components/schemas/DriveToLocationModel' type: array title: Drive To Locations genders: items: $ref: '#/components/schemas/Gender' type: array title: Genders age_ranges: items: $ref: '#/components/schemas/AgeRange' type: array title: Age Ranges enable_alcohol_age: type: boolean title: Enable Alcohol Age enable_privacy_idfas: type: boolean title: Enable Privacy Idfas income_ranges: items: $ref: '#/components/schemas/IncomeRange' type: array title: Income Ranges communities: items: $ref: '#/components/schemas/Community' type: array title: Communities optimization_strategy: $ref: '#/components/schemas/OptimizationStrategy' ctr_threshold: anyOf: - type: number - type: 'null' title: Ctr Threshold sar_threshold: anyOf: - type: integer - type: 'null' title: Sar Threshold conversion_threshold: anyOf: - type: number - type: 'null' title: Conversion Threshold psvr_threshold: anyOf: - type: number - type: 'null' title: Psvr Threshold publisher_categories: items: $ref: '#/components/schemas/app__api__routes__adgroups__models__PublisherCategoryModel' type: array title: Publisher Categories streaming_video_content_categories: items: $ref: '#/components/schemas/app__api__routes__adgroups__models__StreamingVideoContentCategoryModel' type: array title: Streaming Video Content Categories ctv_premium_categories: items: $ref: '#/components/schemas/app__api__routes__adgroups__models__CTVPremiumCategoryModel' type: array title: Ctv Premium Categories audio_podcast_topics: items: $ref: '#/components/schemas/app__api__routes__adgroups__models__AudioPodcastTopicModel' type: array title: Audio Podcast Topics audio_streaming_genres: items: $ref: '#/components/schemas/app__api__routes__adgroups__models__AudioStreamingGenreModel' type: array title: Audio Streaming Genres audio_podcast_ad_positions: items: $ref: '#/components/schemas/AudioPodcastAdPosition' type: array title: Audio Podcast Ad Positions operating_systems: items: $ref: '#/components/schemas/OperatingSystem' type: array title: Operating Systems languages: items: $ref: '#/components/schemas/Language' type: array title: Languages dayparting: items: type: integer type: array title: Dayparting neighborhoods: items: $ref: '#/components/schemas/NeighborhoodModel' type: array title: Neighborhoods neighborhood_types: items: $ref: '#/components/schemas/NeighborhoodType' type: array title: Neighborhood Types created_date: anyOf: - type: string format: date-time - type: 'null' title: Created Date updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date on_premise_locations: items: $ref: '#/components/schemas/OnPremiseLocationModel' type: array title: On Premise Locations completed_steps: items: $ref: '#/components/schemas/AdgroupStep' type: array title: Completed Steps tracking_pixels: items: $ref: '#/components/schemas/TrackingPixelModel' type: array title: Tracking Pixels billability_type: $ref: '#/components/schemas/BillabilityType' added_cost_cpm: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Added Cost Cpm default: '0' viewable_percentage: anyOf: - type: integer - type: 'null' title: Viewable Percentage measurable_percentage: anyOf: - type: integer - type: 'null' title: Measurable Percentage gross_bid_price: anyOf: - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Gross Bid Price ad_package: anyOf: - $ref: '#/components/schemas/AdPackageModel' - type: 'null' budget_padding: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Budget Padding default: '0' daily_impression_cap: anyOf: - type: integer - type: 'null' title: Daily Impression Cap integration_reports: items: $ref: '#/components/schemas/IntegrationReport' type: array title: Integration Reports third_party_placement_name: anyOf: - type: string - type: 'null' title: Third Party Placement Name third_party_placement_id: anyOf: - type: string - type: 'null' title: Third Party Placement Id mobile_carriers: items: $ref: '#/components/schemas/MobileCarrierCode' type: array title: Mobile Carriers exchange_publishers: items: $ref: '#/components/schemas/app__api__routes__adgroups__models__PublisherModel' type: array title: Exchange Publishers custom_publishers: items: $ref: '#/components/schemas/app__api__routes__adgroups__models__PublisherModel' type: array title: Custom Publishers exchange_bid_type: anyOf: - $ref: '#/components/schemas/ExchangeBidType' - type: 'null' exchange_bid_price: anyOf: - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Exchange Bid Price rotate_creatives_evenly: type: boolean title: Rotate Creatives Evenly pacing_mode: $ref: '#/components/schemas/PacingMode' dooh_metadata: anyOf: - $ref: '#/components/schemas/DOOHMetadataModel' - type: 'null' retargeting_segment_name: anyOf: - type: string - type: 'null' title: Retargeting Segment Name type: object required: - id - tenant_id - organization_id - account_id - campaign_id - name - start_date - end_date - status - objective - tactic - media_types - bid_type - bid_price - budgets - gross_budget - budget_type - audiences - lookalike_audience_scale - location_filters - drive_to_locations - genders - age_ranges - enable_alcohol_age - enable_privacy_idfas - income_ranges - communities - optimization_strategy - ctr_threshold - sar_threshold - conversion_threshold - psvr_threshold - publisher_categories - streaming_video_content_categories - ctv_premium_categories - audio_podcast_topics - audio_streaming_genres - audio_podcast_ad_positions - operating_systems - languages - dayparting - neighborhoods - neighborhood_types - on_premise_locations - completed_steps - tracking_pixels - billability_type - integration_reports - mobile_carriers - exchange_publishers - custom_publishers - exchange_bid_type - exchange_bid_price - rotate_creatives_evenly - pacing_mode title: AdgroupModel AdgroupSearchResult: properties: id: type: integer title: Id name: type: string title: Name created_date: anyOf: - type: string format: date-time - type: 'null' title: Created Date start_date: type: string format: date title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date tenant_id: type: integer title: Tenant Id tenant_name: type: string title: Tenant Name organization_id: type: integer title: Organization Id organization_name: type: string title: Organization Name account_id: type: integer title: Account Id account_name: type: string title: Account Name campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name type: object required: - id - name - created_date - start_date - end_date - updated_date - tenant_id - tenant_name - organization_id - organization_name - account_id - account_name - campaign_id - campaign_name title: AdgroupSearchResult AdgroupSpendModel: properties: adgroup_id: type: integer title: Adgroup Id total_spend: type: number title: Total Spend default: 0.0 total_predicted_spend: type: number title: Total Predicted Spend default: 0.0 type: object required: - adgroup_id title: AdgroupSpendModel AdgroupStep: oneOf: - const: 1 title: OBJECTIVE - const: 2 title: MEDIA_CHANNEL - const: 3 title: LOCATION_AUDIENCE - const: 4 title: PLACEMENT - const: 5 title: BUDGET_SCHEDULE - const: 6 title: MEASUREMENT type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 title: AdgroupStep x-enum-varnames: - OBJECTIVE - MEDIA_CHANNEL - LOCATION_AUDIENCE - PLACEMENT - BUDGET_SCHEDULE - MEASUREMENT AdgroupsModel: properties: total_count: type: integer title: Total Count limit: type: integer title: Limit page_num: type: integer title: Page Num total_pages: type: integer title: Total Pages has_next_page: type: boolean title: Has Next Page has_prev_page: type: boolean title: Has Prev Page items: items: $ref: '#/components/schemas/BasicAdgroupModel' type: array title: Items type: object required: - total_count - limit - page_num - total_pages - has_next_page - has_prev_page - items title: AdgroupsModel AdgroupsTodaySpendModel: properties: adgroup_id: type: integer title: Adgroup Id today_spend: type: number title: Today Spend type: object required: - adgroup_id - today_spend title: AdgroupsTodaySpendModel AgeGenderDistributionCampaignModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID (present when all_adgroups=true) adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name (present when all_adgroups=true) age: type: string title: Age description: Age bucket key gender: type: string title: Gender description: Gender key ("m", "f", or "-1" for unknown) impressions: type: integer title: Impressions description: Total impressions clicks: type: integer title: Clicks description: Total clicks spend: type: number title: Spend description: Total spend (gross revenue) ctr: type: number title: Ctr description: 'Click-through rate (percentage: clicks * 100 / impressions)' cpm: type: number title: Cpm description: Cost per thousand impressions (spend / impressions * 1000) total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate (total_sa / clicks) click_to_call: type: number title: Click To Call description: Total click-to-call actions directions: type: number title: Directions description: Total directions actions website: type: number title: Website description: Total website actions moreinfo: type: number title: Moreinfo description: Total more info actions coupon: type: number title: Coupon description: Total coupon actions video: type: number title: Video description: Total video actions cumulative_reach: type: integer title: Cumulative Reach description: Cumulative reach visits: type: integer title: Visits description: Total visits open_hour_visits: type: integer title: Open Hour Visits description: Total open hour visits projected_visits: type: integer title: Projected Visits description: Projected visits (-1 when negative) projected_open_hour_visits: type: integer title: Projected Open Hour Visits description: Projected open hour visits (-1 when negative) video_start: type: integer title: Video Start description: Video start count (vid_0) video_first_quartile: type: integer title: Video First Quartile description: Video first quartile count (vid_25) video_midpoint: type: integer title: Video Midpoint description: Video midpoint count (vid_50) video_third_quartile: type: integer title: Video Third Quartile description: Video third quartile count (vid_75) video_end: type: integer title: Video End description: Video end count (vid_100) vcr: type: number title: Vcr description: Video completion rate (video_end / video_start) ltr: type: number title: Ltr description: Listen-through rate (audio_end / audio_start) type: object required: - account_name - campaign_id - campaign_name - age - gender - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video - cumulative_reach - visits - open_hour_visits - projected_visits - projected_open_hour_visits - video_start - video_first_quartile - video_midpoint - video_third_quartile - video_end - vcr - ltr title: AgeGenderDistributionCampaignModel description: Age+gender distribution row for a campaign (Rocket age_gender_distribution key=3). AgeRange: oneOf: - const: 18-24 title: _18_24 - const: 25-34 title: _25_34 - const: 35-44 title: _35_44 - const: 45-54 title: _45_54 - const: 55-64 title: _55_64 - const: 65-999 title: _65_UP - const: unknown title: UNKNOWN type: string enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65-999 - unknown title: AgeRange x-enum-varnames: - _18_24 - _25_34 - _35_44 - _45_54 - _55_64 - _65_UP - UNKNOWN AppBundleModel: properties: bundle: type: string minLength: 1 title: Bundle exclude: type: boolean title: Exclude type: object required: - bundle - exclude title: AppBundleModel AppCode: type: string enum: - MF - LM - CAB - MP - SM - RA - XC - AD - PE - CP - FR - XA - IO - AV - PM - CBP - BPM - BQA - BPE - API - AM2 title: AppCode Audience: properties: id: type: string title: Id type: type: string title: Type name: type: string title: Name size: anyOf: - type: integer - type: 'null' title: Size description: anyOf: - type: string - type: 'null' title: Description sensitivity: anyOf: - $ref: '#/components/schemas/Sensitivity' - type: 'null' backend_key: anyOf: - type: string - type: 'null' title: Backend Key sic_code: anyOf: - type: string - type: 'null' title: Sic Code location_group_metadata: anyOf: - $ref: '#/components/schemas/app__services__audience__types__LocationGroupMetadata' - type: 'null' category_id: anyOf: - type: integer - type: 'null' title: Category Id status: anyOf: - type: string - type: 'null' title: Status type: object required: - id - type - name - size - description - sensitivity - backend_key - sic_code - location_group_metadata - category_id - status title: Audience AudienceAffinityAdgroupModel: properties: audience_name: type: string title: Audience Name description: Display name of the audience category_id: anyOf: - type: integer - type: 'null' title: Category Id description: Audience category identifier adgroup_id: type: integer title: Adgroup Id description: Adgroup identifier adgroup_name: type: string title: Adgroup Name description: Name of the adgroup imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate type: object required: - audience_name - adgroup_id - adgroup_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst title: AudienceAffinityAdgroupModel AudienceAffinityCampaignCreativeFieldName: oneOf: - const: imp title: IMP description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). - const: clks title: CLKS description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). - const: sa title: SA description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). - const: vst title: VST description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). - const: oh_vst title: OH_VST description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). - const: ctr title: CTR description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). - const: sar title: SAR description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). - const: vr title: VR description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). - const: prj_vst title: PRJ_VST description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). - const: prj_oh_vst title: PRJ_OH_VST description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). - const: vcr title: VCR description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). type: string enum: - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr title: AudienceAffinityCampaignCreativeFieldName description: Sort-by fields for audience affinity v2 campaign endpoint (no ltr). x-enum-varnames: - IMP - CLKS - SA - VST - OH_VST - CTR - SAR - VR - PRJ_VST - PRJ_OH_VST - VCR AudienceAffinityCampaignModel: properties: audience_name: type: string title: Audience Name description: Display name of the audience category_id: anyOf: - type: integer - type: 'null' title: Category Id description: Audience category identifier campaign_id: type: integer title: Campaign Id description: Campaign identifier campaign_name: type: string title: Campaign Name description: Name of the campaign imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - audience_name - campaign_id - campaign_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst title: AudienceAffinityCampaignModel AudienceAffinityCampaignSummaryModel: properties: ctr: type: number title: Ctr description: Click-through rate category_id: type: integer title: Category Id description: Audience category identifier audience_name: type: string title: Audience Name description: Display name of the audience type: object required: - ctr - category_id - audience_name title: AudienceAffinityCampaignSummaryModel description: Campaign audience affinity summary (ctr, category_id, audience_name). AudienceAffinityCreativeModel: properties: audience_name: type: string title: Audience Name description: Display name of the audience category_id: anyOf: - type: integer - type: 'null' title: Category Id description: Audience category identifier creative_id: type: integer title: Creative Id description: Creative identifier creative_name: type: string title: Creative Name description: Name of the creative imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - audience_name - creative_id - creative_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst title: AudienceAffinityCreativeModel AudienceAffinityFieldName: oneOf: - const: imp title: IMP - const: clks title: CLKS - const: sa title: SA - const: vst title: VST - const: oh_vst title: OH_VST - const: ctr title: CTR - const: sar title: SAR - const: vr title: VR - const: prj_vst title: PRJ_VST - const: prj_oh_vst title: PRJ_OH_VST - const: vcr title: VCR - const: ltr title: LTR type: string enum: - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr - ltr title: AudienceAffinityFieldName x-enum-varnames: - IMP - CLKS - SA - VST - OH_VST - CTR - SAR - VR - PRJ_VST - PRJ_OH_VST - VCR - LTR AudienceBehavioralCreativeResponseModel: properties: a_id: type: integer title: A Id description: Behaviour dimension id a_name: type: string title: A Name description: Behaviour display name creative_id: type: integer title: Creative Id description: Creative ID creative_name: type: string title: Creative Name description: Creative name imp: type: number title: Imp description: Impressions clks: type: number title: Clks description: Clicks sa: type: number title: Sa description: Total secondary actions vst: type: number title: Vst description: Visits oh_vst: type: number title: Oh Vst description: Open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - a_id - a_name - creative_id - creative_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst title: AudienceBehavioralCreativeResponseModel description: Rocket-shaped response for audience behavioral creative (AUDIENCE_INSIGHTS_BHAUD_CREATIVE). AudienceBehavioralSortByFieldName: oneOf: - const: imp title: IMP description: 'Sort-by fields for audience behavioral (bhaud) endpoints: campaign creatives and creative.' - const: clks title: CLKS description: 'Sort-by fields for audience behavioral (bhaud) endpoints: campaign creatives and creative.' - const: sa title: SA description: 'Sort-by fields for audience behavioral (bhaud) endpoints: campaign creatives and creative.' - const: ctr title: CTR description: 'Sort-by fields for audience behavioral (bhaud) endpoints: campaign creatives and creative.' - const: vr title: VR description: 'Sort-by fields for audience behavioral (bhaud) endpoints: campaign creatives and creative.' type: string enum: - imp - clks - sa - ctr - vr title: AudienceBehavioralSortByFieldName description: 'Sort-by fields for audience behavioral (bhaud) endpoints: campaign creatives and creative.' x-enum-varnames: - IMP - CLKS - SA - CTR - VR AudienceBreakdownAdgroupResponseModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID, present when all_creatives is true creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name, present when all_creatives is true category_id: type: string title: Category Id description: Audience category ID (brand, SIC code, or behaviour) display_name: type: string title: Display Name description: Audience category display name impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Total spend (gross revenue) ctr: type: number title: Ctr description: Click-through rate cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Total click-to-call actions directions: type: number title: Directions description: Total directions actions website: type: number title: Website description: Total website actions moreinfo: type: number title: Moreinfo description: Total more info actions coupon: type: number title: Coupon description: Total coupon actions video: type: number title: Video description: Total video actions ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate type: object required: - account_name - campaign_id - campaign_name - adgroup_id - adgroup_name - category_id - display_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video title: AudienceBreakdownAdgroupResponseModel AudienceBreakdownCampaignResponseModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID, present when all_adgroups or all_creatives is true adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name, present when all_adgroups or all_creatives is true creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID, present when all_creatives is true creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name, present when all_creatives is true category_id: type: string title: Category Id description: Audience category ID (brand, SIC code, or behaviour) display_name: type: string title: Display Name description: Audience category display name impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Total spend (gross revenue) ctr: type: number title: Ctr description: Click-through rate cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Total click-to-call actions directions: type: number title: Directions description: Total directions actions website: type: number title: Website description: Total website actions moreinfo: type: number title: Moreinfo description: Total more info actions coupon: type: number title: Coupon description: Total coupon actions video: type: number title: Video description: Total video actions ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate type: object required: - account_name - campaign_id - campaign_name - category_id - display_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video title: AudienceBreakdownCampaignResponseModel AudienceBreakdownCreativeResponseModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name creative_id: type: integer title: Creative Id description: Creative ID creative_name: type: string title: Creative Name description: Creative name category_id: type: string title: Category Id description: Audience category ID (brand, SIC code, or behaviour) display_name: type: string title: Display Name description: Audience category display name impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Total spend (gross revenue) ctr: type: number title: Ctr description: Click-through rate cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Total click-to-call actions directions: type: number title: Directions description: Total directions actions website: type: number title: Website description: Total website actions moreinfo: type: number title: Moreinfo description: Total more info actions coupon: type: number title: Coupon description: Total coupon actions video: type: number title: Video description: Total video actions ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate type: object required: - account_name - campaign_id - campaign_name - adgroup_id - adgroup_name - creative_id - creative_name - category_id - display_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video title: AudienceBreakdownCreativeResponseModel AudienceBreakdownV1AdgroupResponseModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID, present when all_creatives is true creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name, present when all_creatives is true brand_id: anyOf: - type: integer - type: 'null' title: Brand Id description: Brand ID, returned in case of brand (key=1) display_name: anyOf: - type: string - type: 'null' title: Display Name description: Brand display name, returned in case of brand (key=1) sic_code: anyOf: - type: integer - type: 'null' title: Sic Code description: SIC code, returned in case of category (key=2) sic_code_name: anyOf: - type: string - type: 'null' title: Sic Code Name description: SIC code description, returned in case of category (key=2) impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Total spend (gross revenue) ctr: type: number title: Ctr description: Click-through rate cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Total click-to-call actions directions: type: number title: Directions description: Total directions actions website: type: number title: Website description: Total website actions moreinfo: type: number title: Moreinfo description: Total more info actions coupon: type: number title: Coupon description: Total coupon actions video: type: number title: Video description: Total video actions type: object required: - account_name - campaign_id - campaign_name - adgroup_id - adgroup_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video title: AudienceBreakdownV1AdgroupResponseModel AudienceBreakdownV1CampaignResponseModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID, present when all_adgroups or all_creatives is true adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name, present when all_adgroups or all_creatives is true creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID, present when all_creatives is true creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name, present when all_creatives is true brand_id: anyOf: - type: integer - type: 'null' title: Brand Id description: Brand ID, returned in case of brand (key=1) display_name: anyOf: - type: string - type: 'null' title: Display Name description: Brand display name, returned in case of brand (key=1) sic_code: anyOf: - type: integer - type: 'null' title: Sic Code description: SIC code, returned in case of category (key=2) sic_code_name: anyOf: - type: string - type: 'null' title: Sic Code Name description: SIC code description, returned in case of category (key=2) impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Total spend (gross revenue) ctr: type: number title: Ctr description: Click-through rate cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Total click-to-call actions directions: type: number title: Directions description: Total directions actions website: type: number title: Website description: Total website actions moreinfo: type: number title: Moreinfo description: Total more info actions coupon: type: number title: Coupon description: Total coupon actions video: type: number title: Video description: Total video actions type: object required: - account_name - campaign_id - campaign_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video title: AudienceBreakdownV1CampaignResponseModel AudienceBreakdownV1CreativeResponseModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name creative_id: type: integer title: Creative Id description: Creative ID creative_name: type: string title: Creative Name description: Creative name brand_id: anyOf: - type: integer - type: 'null' title: Brand Id description: Brand ID, returned in case of brand (key=1) display_name: anyOf: - type: string - type: 'null' title: Display Name description: Brand display name, returned in case of brand (key=1) sic_code: anyOf: - type: integer - type: 'null' title: Sic Code description: SIC code, returned in case of category (key=2) sic_code_name: anyOf: - type: string - type: 'null' title: Sic Code Name description: SIC code description, returned in case of category (key=2) impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Total spend (gross revenue) ctr: type: number title: Ctr description: Click-through rate cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Total click-to-call actions directions: type: number title: Directions description: Total directions actions website: type: number title: Website description: Total website actions moreinfo: type: number title: Moreinfo description: Total more info actions coupon: type: number title: Coupon description: Total coupon actions video: type: number title: Video description: Total video actions type: object required: - account_name - campaign_id - campaign_name - adgroup_id - adgroup_name - creative_id - creative_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video title: AudienceBreakdownV1CreativeResponseModel AudienceBreakdownV1Key: type: integer enum: - 1 - 2 title: AudienceBreakdownV1Key AudienceCategoryAdgroupFieldName: oneOf: - const: imp title: IMP - const: clks title: CLKS - const: sa title: SA - const: vst title: VST - const: oh_vst title: OH_VST - const: ctr title: CTR - const: sar title: SAR - const: vr title: VR - const: prj_vst title: PRJ_VST - const: prj_oh_vst title: PRJ_OH_VST - const: vcr title: VCR - const: ltr title: LTR type: string enum: - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr - ltr title: AudienceCategoryAdgroupFieldName x-enum-varnames: - IMP - CLKS - SA - VST - OH_VST - CTR - SAR - VR - PRJ_VST - PRJ_OH_VST - VCR - LTR AudienceCategoryAdgroupModel: properties: sic: type: string title: Sic c_name: type: string title: C Name adgroup_id: type: integer title: Adgroup Id adgroup_name: type: string title: Adgroup Name imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate type: object required: - sic - c_name - adgroup_id - adgroup_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr - ltr title: AudienceCategoryAdgroupModel AudienceCategoryCampaignAllAdgroupsModel: properties: sic: type: string title: Sic c_name: type: string title: C Name adgroup_id: type: integer title: Adgroup Id adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate type: object required: - sic - c_name - adgroup_id - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr - ltr title: AudienceCategoryCampaignAllAdgroupsModel AudienceCategoryCampaignCreativesModel: properties: sic: type: string title: Sic category_name: type: string title: Category Name creative_id: type: integer title: Creative Id creative_name: anyOf: - type: string - type: 'null' title: Creative Name imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - sic - category_name - creative_id - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr title: AudienceCategoryCampaignCreativesModel AudienceCategoryCampaignModel: properties: sic: type: string title: Sic c_name: type: string title: C Name campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - sic - c_name - campaign_id - campaign_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr title: AudienceCategoryCampaignModel AudienceCategoryCreativeFieldName: oneOf: - const: imp title: IMP - const: clks title: CLKS - const: sa title: SA - const: vst title: VST - const: oh_vst title: OH_VST - const: ctr title: CTR - const: sar title: SAR - const: vr title: VR - const: prj_vst title: PRJ_VST - const: prj_oh_vst title: PRJ_OH_VST - const: vcr title: VCR type: string enum: - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr title: AudienceCategoryCreativeFieldName x-enum-varnames: - IMP - CLKS - SA - VST - OH_VST - CTR - SAR - VR - PRJ_VST - PRJ_OH_VST - VCR AudienceCategoryCreativeModel: properties: sic: type: string title: Sic c_name: type: string title: C Name creative_id: type: integer title: Creative Id creative_name: type: string title: Creative Name imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - sic - c_name - creative_id - creative_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr title: AudienceCategoryCreativeModel AudienceCategoryFieldName: oneOf: - const: imp title: IMP - const: clks title: CLKS - const: sa title: SA - const: vst title: VST - const: oh_vst title: OH_VST - const: ctr title: CTR - const: sar title: SAR - const: vr title: VR - const: prj_vst title: PRJ_VST - const: prj_oh_vst title: PRJ_OH_VST - const: vcr title: VCR type: string enum: - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr title: AudienceCategoryFieldName x-enum-varnames: - IMP - CLKS - SA - VST - OH_VST - CTR - SAR - VR - PRJ_VST - PRJ_OH_VST - VCR AudienceModel: properties: id: type: string title: Id name: type: string title: Name type: $ref: '#/components/schemas/app__api__routes__adgroups__constants__AudienceType' exclude: type: boolean title: Exclude size: anyOf: - type: integer - type: 'null' title: Size description: anyOf: - type: string - type: 'null' title: Description sensitivity: anyOf: - $ref: '#/components/schemas/Sensitivity' - type: 'null' status: anyOf: - $ref: '#/components/schemas/ThirdPartyAudienceStatus' - type: 'null' category_id: anyOf: - type: integer - type: 'null' title: Category Id location_group_metadata: anyOf: - $ref: '#/components/schemas/app__api__models__LocationGroupMetadata' - type: 'null' type: object required: - id - name - type - exclude - size title: AudienceModel AudienceRecommendationsModel: properties: recommendations: items: $ref: '#/components/schemas/Audience' type: array title: Recommendations type: object required: - recommendations title: AudienceRecommendationsModel AudienceRecommendationsRequestModel: properties: audience_ids: items: type: string type: array title: Audience Ids type: object required: - audience_ids title: AudienceRecommendationsRequestModel AudienceSearchResult: properties: category: anyOf: - $ref: '#/components/schemas/DetailedAudienceCategory' - type: 'null' audience: anyOf: - $ref: '#/components/schemas/Audience' - type: 'null' type: object required: - category - audience title: AudienceSearchResult AudienceTaxonomy: properties: items: items: $ref: '#/components/schemas/app__services__audience__types__AudienceType' type: array title: Items type: object required: - items title: AudienceTaxonomy AudienceType-Input: oneOf: - const: behavior title: BEHAVIOR - const: custom_audience title: CUSTOM_AUDIENCE - const: segment title: SEGMENT - const: brand title: BRAND - const: category title: CATEGORY - const: location_group title: LOCATION_GROUP - const: third_party title: THIRD_PARTY type: string enum: - behavior - custom_audience - segment - brand - category - location_group - third_party title: AudienceType x-enum-varnames: - BEHAVIOR - CUSTOM_AUDIENCE - SEGMENT - BRAND - CATEGORY - LOCATION_GROUP - THIRD_PARTY AudioPodcastAdPosition: oneOf: - const: 0 title: PRE_ROLL - const: -1 title: MID_ROLL - const: -2 title: POST_ROLL type: integer enum: - 0 - -1 - -2 title: AudioPodcastAdPosition x-enum-varnames: - PRE_ROLL - MID_ROLL - POST_ROLL AudioPodcastAdPositionCampaignAdgroupsModel: properties: adgroup_id: type: integer title: Adgroup Id adgroup_name: type: string title: Adgroup Name pre_roll_imp: type: integer title: Pre Roll Imp pre_roll_ltr: type: number title: Pre Roll Ltr mid_roll_imp: type: integer title: Mid Roll Imp mid_roll_ltr: type: number title: Mid Roll Ltr post_roll_imp: type: integer title: Post Roll Imp post_roll_ltr: type: number title: Post Roll Ltr imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate type: object required: - adgroup_id - adgroup_name - pre_roll_imp - pre_roll_ltr - mid_roll_imp - mid_roll_ltr - post_roll_imp - post_roll_ltr - imp - ltr title: AudioPodcastAdPositionCampaignAdgroupsModel AudioPodcastAdPositionCampaignModel: properties: campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name pre_roll_imp: type: integer title: Pre Roll Imp pre_roll_ltr: type: number title: Pre Roll Ltr mid_roll_imp: type: integer title: Mid Roll Imp mid_roll_ltr: type: number title: Mid Roll Ltr post_roll_imp: type: integer title: Post Roll Imp post_roll_ltr: type: number title: Post Roll Ltr imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate type: object required: - campaign_id - campaign_name - pre_roll_imp - pre_roll_ltr - mid_roll_imp - mid_roll_ltr - post_roll_imp - post_roll_ltr - imp - ltr title: AudioPodcastAdPositionCampaignModel AudioPodcastFieldName: oneOf: - const: imp title: IMP - const: ltr title: LTR type: string enum: - imp - ltr title: AudioPodcastFieldName x-enum-varnames: - IMP - LTR AudioPodcastSeriesMetricsAdgroupModel: properties: adgroup_id: type: integer title: Adgroup Id adgroup_name: type: string title: Adgroup Name series: type: string title: Series imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate type: object required: - adgroup_id - adgroup_name - series - imp - ltr title: AudioPodcastSeriesMetricsAdgroupModel AudioPodcastSeriesMetricsCampaignModel: properties: adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name series: type: string title: Series imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name type: object required: - series - imp - ltr title: AudioPodcastSeriesMetricsCampaignModel AudioPodcastTopicMetricsAdgroupModel: properties: adgroup_id: type: integer title: Adgroup Id adgroup_name: type: string title: Adgroup Name topic: type: string title: Topic imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate type: object required: - adgroup_id - adgroup_name - topic - imp - ltr title: AudioPodcastTopicMetricsAdgroupModel AudioPodcastTopicMetricsCampaignModel: properties: adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name topic: type: string title: Topic imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name type: object required: - topic - imp - ltr title: AudioPodcastTopicMetricsCampaignModel AudioPodcastTopicsModel: properties: items: items: $ref: '#/components/schemas/app__api__routes__static__models__AudioPodcastTopicModel' type: array title: Items type: object required: - items title: AudioPodcastTopicsModel AudioPublisherAdgroupModel: properties: publisher_name: type: string title: Publisher Name imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate type: object required: - publisher_name - imp - ltr title: AudioPublisherAdgroupModel AudioPublisherCampaignAllAdgroupsModel: properties: adgroup_id: type: integer title: Adgroup Id adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name publisher_name: type: string title: Publisher Name imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate type: object required: - adgroup_id - publisher_name - imp - ltr title: AudioPublisherCampaignAllAdgroupsModel AudioPublisherCampaignModel: properties: campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name app_site_publisher_name: type: string title: App Site Publisher Name imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate type: object required: - campaign_id - campaign_name - app_site_publisher_name - imp - ltr title: AudioPublisherCampaignModel AudioStreamingGenreAdgroupModel: properties: adgroup_id: type: integer title: Adgroup Id adgroup_name: type: string title: Adgroup Name genre: type: string title: Genre imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate type: object required: - adgroup_id - adgroup_name - genre - imp - ltr title: AudioStreamingGenreAdgroupModel AudioStreamingGenreCampaignAllAdgroupsModel: properties: adgroup_id: type: integer title: Adgroup Id adgroup_name: type: string title: Adgroup Name genre: type: string title: Genre imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate type: object required: - adgroup_id - adgroup_name - genre - imp - ltr title: AudioStreamingGenreCampaignAllAdgroupsModel AudioStreamingGenreCampaignModel: properties: campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name genre: type: string title: Genre imp: type: integer title: Imp description: Total impressions ltr: type: number title: Ltr description: Listen-through rate type: object required: - campaign_id - campaign_name - genre - imp - ltr title: AudioStreamingGenreCampaignModel AudioStreamingGenresModel: properties: items: items: $ref: '#/components/schemas/app__api__routes__static__models__AudioStreamingGenreModel' type: array title: Items type: object required: - items title: AudioStreamingGenresModel BannerSizeBreakdownAdgroupModel: properties: account_name: anyOf: - type: string - type: 'null' title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID, present when all_creatives is true creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name, present when all_creatives is true banner_size: anyOf: - type: string - type: 'null' title: Banner Size description: Banner size (e.g. 300x250) impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Spend (xad gross revenue) ctr: type: number title: Ctr description: Click-through rate (percent) cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Click-to-call actions directions: type: number title: Directions description: Directions actions website: type: number title: Website description: Website actions moreinfo: type: number title: Moreinfo description: More info actions coupon: type: number title: Coupon description: Coupon actions video: type: number title: Video description: Video (media) actions visits: type: number title: Visits description: Total visits cumulative_reach: type: number title: Cumulative Reach description: Cumulative reach for the banner size svr: anyOf: - type: number - type: 'null' title: Svr description: Store visitation rate, null when all_creatives is true svl: anyOf: - type: number - type: 'null' title: Svl description: Store visitation lift, null when all_creatives is true type: object required: - campaign_id - campaign_name - adgroup_id - adgroup_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video - visits - cumulative_reach title: BannerSizeBreakdownAdgroupModel description: Banner-size breakdown metrics for an ad group, optionally split by creative. BannerSizeBreakdownCampaignModel: properties: account_name: anyOf: - type: string - type: 'null' title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID, present when all_adgroups or all_creatives is true adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name, present when all_adgroups or all_creatives is true creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID, present when all_creatives is true creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name, present when all_creatives is true banner_size: anyOf: - type: string - type: 'null' title: Banner Size description: Banner size (e.g. 300x250) impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Spend (xad gross revenue) ctr: type: number title: Ctr description: Click-through rate (percent) cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Click-to-call actions directions: type: number title: Directions description: Directions actions website: type: number title: Website description: Website actions moreinfo: type: number title: Moreinfo description: More info actions coupon: type: number title: Coupon description: Coupon actions video: type: number title: Video description: Video (media) actions visits: type: number title: Visits description: Total visits cumulative_reach: type: number title: Cumulative Reach description: Cumulative reach for the banner size svr: anyOf: - type: number - type: 'null' title: Svr description: Store visitation rate, null when all_creatives is true svl: anyOf: - type: number - type: 'null' title: Svl description: Store visitation lift, null when all_creatives is true type: object required: - campaign_id - campaign_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video - visits - cumulative_reach title: BannerSizeBreakdownCampaignModel description: Banner-size breakdown metrics for a campaign, optionally split by ad group or creative. BasicAdgroupModel: properties: id: type: integer title: Id tenant_id: type: integer title: Tenant Id organization_id: type: integer title: Organization Id account_id: type: integer title: Account Id campaign_id: type: integer title: Campaign Id name: type: string title: Name start_date: type: string format: date title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date status: $ref: '#/components/schemas/Status' created_date: anyOf: - type: string format: date-time - type: 'null' title: Created Date updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date type: object required: - id - tenant_id - organization_id - account_id - campaign_id - name - start_date - end_date - status title: BasicAdgroupModel BestAudiencesModel: properties: name: type: string title: Name count: type: integer title: Count percentage: type: integer title: Percentage type: object required: - name - count - percentage title: BestAudiencesModel BestAudiencesSummaryModel: properties: visits: items: $ref: '#/components/schemas/BestAudiencesModel' type: array title: Visits clicks: items: $ref: '#/components/schemas/BestAudiencesModel' type: array title: Clicks impressions: items: $ref: '#/components/schemas/BestAudiencesModel' type: array title: Impressions type: object required: - visits - clicks - impressions title: BestAudiencesSummaryModel BestStrategiesModel: properties: name: type: string title: Name val: type: number title: Val type: object required: - name - val title: BestStrategiesModel BestStrategiesSummaryModel: properties: impressions: items: $ref: '#/components/schemas/BestStrategiesModel' type: array title: Impressions ctr: items: $ref: '#/components/schemas/BestStrategiesModel' type: array title: Ctr vr: items: $ref: '#/components/schemas/BestStrategiesModel' type: array title: Vr type: object required: - impressions - ctr - vr title: BestStrategiesSummaryModel BillabilityType: oneOf: - const: 0 title: BILLABLE - const: 1 title: ADDED_VALUE - const: 2 title: MAKE_GOOD - const: 3 title: SURVEY - const: 4 title: TEST type: integer enum: - 0 - 1 - 2 - 3 - 4 title: BillabilityType x-enum-varnames: - BILLABLE - ADDED_VALUE - MAKE_GOOD - SURVEY - TEST BillingSource: oneOf: - const: 1 title: XAD - const: 2 title: DART - const: 3 title: AARKI - const: 4 title: BEINTO - const: 5 title: BONZAI - const: 6 title: BRIDGETRACK - const: 7 title: CELTRA - const: 8 title: EYERETURN - const: 9 title: FLASHTALKING - const: 10 title: JIVOX - const: 11 title: KATANA - const: 12 title: LIN_MEDIA - const: 13 title: MEDIALETS - const: 14 title: MEDIAMIND_SIZMEK - const: 15 title: MIXPO - const: 16 title: PHLUANT - const: 17 title: POINTROLL - const: 18 title: SIMPLYTICS - const: 19 title: ATLAS - const: 20 title: MEDIAPLEX - const: 21 title: S4M_NGINX - const: 22 title: TRUEFFECTS - const: 24 title: INNOVID - const: 25 title: VINDICO - const: 26 title: ADFORM - const: 31 title: ADGEAR - const: 32 title: MIAOZHEN - const: 36 title: IQMOBILE - const: 41 title: ADOBE_ANALYTICS type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 24 - 25 - 26 - 31 - 32 - 36 - 41 title: BillingSource x-enum-varnames: - XAD - DART - AARKI - BEINTO - BONZAI - BRIDGETRACK - CELTRA - EYERETURN - FLASHTALKING - JIVOX - KATANA - LIN_MEDIA - MEDIALETS - MEDIAMIND_SIZMEK - MIXPO - PHLUANT - POINTROLL - SIMPLYTICS - ATLAS - MEDIAPLEX - S4M_NGINX - TRUEFFECTS - INNOVID - VINDICO - ADFORM - ADGEAR - MIAOZHEN - IQMOBILE - ADOBE_ANALYTICS BlueprintsPolygonTypes: oneOf: - const: MultiPolygon title: MULTIPOLYGON - const: Polygon title: POLYGON type: string enum: - MultiPolygon - Polygon title: BlueprintsPolygonTypes x-enum-varnames: - MULTIPOLYGON - POLYGON Body_upload_upload_post: properties: file: type: string format: binary title: File type: object required: - file title: Body_upload_upload_post BrandAffinityAdgroupFieldName: oneOf: - const: imp title: IMP description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). - const: clks title: CLKS description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). - const: sa title: SA description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). - const: vst title: VST description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). - const: oh_vst title: OH_VST description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). - const: ctr title: CTR description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). - const: sar title: SAR description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). - const: vr title: VR description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). - const: prj_vst title: PRJ_VST description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). - const: prj_oh_vst title: PRJ_OH_VST description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). - const: vcr title: VCR description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). type: string enum: - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr title: BrandAffinityAdgroupFieldName description: Sort-by fields for brand affinity ad group endpoint (Rocket audience insights brand). x-enum-varnames: - IMP - CLKS - SA - VST - OH_VST - CTR - SAR - VR - PRJ_VST - PRJ_OH_VST - VCR BrandAffinityAdgroupModel: properties: brand_id: type: integer title: Brand Id description: Brand identifier brand_name: type: string title: Brand Name description: Business name of the brand adgroup_id: type: integer title: Adgroup Id description: Ad group identifier adgroup_name: type: string title: Adgroup Name description: Name of the ad group imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - brand_id - brand_name - adgroup_id - adgroup_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst title: BrandAffinityAdgroupModel description: Brand affinity (audience insights brand) metrics at ad group level. BrandAffinityCampaignAdgroupsFieldName: oneOf: - const: imp title: IMP description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). - const: clks title: CLKS description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). - const: sa title: SA description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). - const: vst title: VST description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). - const: oh_vst title: OH_VST description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). - const: ctr title: CTR description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). - const: sar title: SAR description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). - const: vr title: VR description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). - const: prj_vst title: PRJ_VST description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). - const: prj_oh_vst title: PRJ_OH_VST description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). - const: vcr title: VCR description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). - const: ltr title: LTR description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). type: string enum: - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr - ltr title: BrandAffinityCampaignAdgroupsFieldName description: Sort-by fields for brand affinity campaign adgroups endpoint (Rocket audience insights brand export). x-enum-varnames: - IMP - CLKS - SA - VST - OH_VST - CTR - SAR - VR - PRJ_VST - PRJ_OH_VST - VCR - LTR BrandAffinityCampaignAdgroupsModel: properties: brand_id: type: integer title: Brand Id description: Brand identifier brand_name: type: string title: Brand Name description: Business name of the brand adgroup_id: type: integer title: Adgroup Id description: Ad group identifier adgroup_name: type: string title: Adgroup Name description: Name of the ad group imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate type: object required: - brand_id - brand_name - adgroup_id - adgroup_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst title: BrandAffinityCampaignAdgroupsModel description: Brand affinity (audience insights brand) metrics for ad groups within a campaign. BrandAffinityCampaignCreativesFieldName: oneOf: - const: imp title: IMP description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). - const: clks title: CLKS description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). - const: sa title: SA description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). - const: vst title: VST description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). - const: oh_vst title: OH_VST description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). - const: ctr title: CTR description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). - const: sar title: SAR description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). - const: vr title: VR description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). - const: prj_vst title: PRJ_VST description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). - const: prj_oh_vst title: PRJ_OH_VST description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). - const: vcr title: VCR description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). type: string enum: - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr title: BrandAffinityCampaignCreativesFieldName description: Sort-by fields for brand affinity campaign creatives endpoint (Rocket audience insights brand export). x-enum-varnames: - IMP - CLKS - SA - VST - OH_VST - CTR - SAR - VR - PRJ_VST - PRJ_OH_VST - VCR BrandAffinityCampaignCreativesModel: properties: brand_id: type: integer title: Brand Id description: Brand identifier brand_name: type: string title: Brand Name description: Business name of the brand creative_id: type: integer title: Creative Id description: Creative identifier creative_name: type: string title: Creative Name description: Name of the creative imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - brand_id - brand_name - creative_id - creative_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst title: BrandAffinityCampaignCreativesModel description: Brand affinity (audience insights brand) metrics for creatives within a campaign. BrandAffinityCampaignFieldName: oneOf: - const: imp title: IMP description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). - const: clks title: CLKS description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). - const: sa title: SA description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). - const: vst title: VST description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). - const: oh_vst title: OH_VST description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). - const: ctr title: CTR description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). - const: sar title: SAR description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). - const: vr title: VR description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). - const: prj_vst title: PRJ_VST description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). - const: prj_oh_vst title: PRJ_OH_VST description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). - const: vcr title: VCR description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). type: string enum: - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr title: BrandAffinityCampaignFieldName description: Sort-by fields for brand affinity campaign endpoint (Rocket audience insights brand). x-enum-varnames: - IMP - CLKS - SA - VST - OH_VST - CTR - SAR - VR - PRJ_VST - PRJ_OH_VST - VCR BrandAffinityCampaignModel: properties: brand_id: type: integer title: Brand Id description: Brand identifier brand_name: type: string title: Brand Name description: Business name of the brand campaign_id: type: integer title: Campaign Id description: Campaign identifier campaign_name: type: string title: Campaign Name description: Name of the campaign imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - brand_id - brand_name - campaign_id - campaign_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst title: BrandAffinityCampaignModel description: Brand affinity (audience insights brand) metrics at campaign level. BrandAffinityCreativeFieldName: oneOf: - const: imp title: IMP description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). - const: clks title: CLKS description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). - const: sa title: SA description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). - const: vst title: VST description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). - const: oh_vst title: OH_VST description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). - const: ctr title: CTR description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). - const: sar title: SAR description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). - const: vr title: VR description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). - const: prj_vst title: PRJ_VST description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). - const: prj_oh_vst title: PRJ_OH_VST description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). - const: vcr title: VCR description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). type: string enum: - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst - vcr title: BrandAffinityCreativeFieldName description: Sort-by fields for brand affinity creative endpoint (Rocket audience insights brand). x-enum-varnames: - IMP - CLKS - SA - VST - OH_VST - CTR - SAR - VR - PRJ_VST - PRJ_OH_VST - VCR BrandAffinityCreativeModel: properties: brand_id: type: integer title: Brand Id description: Brand identifier brand_name: type: string title: Brand Name description: Business name of the brand creative_id: type: integer title: Creative Id description: Creative identifier creative_name: type: string title: Creative Name description: Name of the creative imp: type: integer title: Imp description: Total impressions clks: type: integer title: Clks description: Total clicks sa: type: integer title: Sa description: Total secondary actions vst: type: integer title: Vst description: Total visits oh_vst: type: integer title: Oh Vst description: Total open hour visits ctr: type: number title: Ctr description: Click-through rate sar: type: number title: Sar description: Secondary action rate vr: type: number title: Vr description: Visit rate prj_vst: type: integer title: Prj Vst description: Projected visits prj_oh_vst: type: integer title: Prj Oh Vst description: Projected open hour visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - brand_id - brand_name - creative_id - creative_name - imp - clks - sa - vst - oh_vst - ctr - sar - vr - prj_vst - prj_oh_vst title: BrandAffinityCreativeModel description: Brand affinity (audience insights brand) metrics at creative level. BudgetLevel: oneOf: - const: campaign title: CAMPAIGN - const: adgroup title: ADGROUP type: string enum: - campaign - adgroup title: BudgetLevel x-enum-varnames: - CAMPAIGN - ADGROUP BudgetModel-Input: properties: start_date: type: string format: date title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date budget: anyOf: - type: number minimum: 0.0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Budget description: If budget is at the campaign level, this will be 0 type: object required: - start_date - end_date - budget title: BudgetModel BudgetModel-Output: properties: start_date: type: string format: date title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date budget: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Budget description: If budget is at the campaign level, this will be 0 type: object required: - start_date - end_date - budget title: BudgetModel BudgetType: oneOf: - const: 0 title: LIFETIME - const: 1 title: PERIODIC - const: 2 title: TIME_PERIOD - const: 3 title: DAILY type: integer enum: - 0 - 1 - 2 - 3 title: BudgetType x-enum-varnames: - LIFETIME - PERIODIC - TIME_PERIOD - DAILY BusinessType: oneOf: - const: 0 title: OTHER - const: 1 title: CHANNEL_SELF_SERVE - const: 2 title: CHANNEL_MANAGED - const: 3 title: AGENCY_DIRECT - const: 4 title: HOLDING_COMPANY - const: 5 title: BRAND_DIRECT - const: 6 title: MID_MARKET type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 title: BusinessType x-enum-varnames: - OTHER - CHANNEL_SELF_SERVE - CHANNEL_MANAGED - AGENCY_DIRECT - HOLDING_COMPANY - BRAND_DIRECT - MID_MARKET CTVAppModel: properties: name: type: string title: Name logo_url: type: string title: Logo Url type: object required: - name - logo_url title: CTVAppModel CTVPremiumCategoriesModel: properties: items: items: $ref: '#/components/schemas/app__api__routes__static__models__CTVPremiumCategoryModel' type: array title: Items type: object required: - items title: CTVPremiumCategoriesModel CampaignAndAdgroupsModel: properties: campaign: $ref: '#/components/schemas/CampaignModel' adgroups: items: $ref: '#/components/schemas/AdgroupModel' type: array title: Adgroups type: object required: - campaign - adgroups title: CampaignAndAdgroupsModel CampaignBudgetType: oneOf: - const: 0 title: LIFETIME - const: 3 title: DAILY type: integer enum: - 0 - 3 title: CampaignBudgetType x-enum-varnames: - LIFETIME - DAILY CampaignDashboardItemModel: properties: id: type: integer title: Id name: type: string title: Name start_date: type: string format: date title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date status: $ref: '#/components/schemas/CampaignDashboardStatus' account_id: type: integer title: Account Id account_name: type: string title: Account Name organization_id: type: integer title: Organization Id organization_name: type: string title: Organization Name salesforce_number: anyOf: - type: string - type: 'null' title: Salesforce Number days_remaining: anyOf: - type: integer - type: 'null' title: Days Remaining budget: anyOf: - type: number - type: 'null' title: Budget gross_budget: anyOf: - type: number - type: 'null' title: Gross Budget budget_type: $ref: '#/components/schemas/BudgetType' pacing: anyOf: - type: number - type: 'null' title: Pacing impressions: anyOf: - type: integer - type: 'null' title: Impressions clicks: anyOf: - type: integer - type: 'null' title: Clicks visits: anyOf: - type: integer - type: 'null' title: Visits vr: anyOf: - type: number - type: 'null' title: Vr vcr: anyOf: - type: number - type: 'null' title: Vcr ctr: anyOf: - type: number - type: 'null' title: Ctr daily_spend: anyOf: - type: number - type: 'null' title: Daily Spend spends_spent: anyOf: - type: number - type: 'null' title: Spends Spent secondary_actions: anyOf: - type: number - type: 'null' title: Secondary Actions sar: anyOf: - type: number - type: 'null' title: Sar reach: anyOf: - type: number - type: 'null' title: Reach conversions: anyOf: - type: integer - type: 'null' title: Conversions type: object required: - id - name - start_date - status - account_id - account_name - organization_id - organization_name - budget_type title: CampaignDashboardItemModel CampaignDashboardSortField: oneOf: - const: name title: NAME - const: id title: ID - const: account_id title: ACCOUNT_ID - const: account_name title: ACCOUNT_NAME - const: organization_id title: ORGANIZATION_ID - const: organization_name title: ORGANIZATION_NAME - const: status title: STATUS - const: days_remaining title: DAYS_REMAINING - const: start_date title: START_DATE - const: end_date title: END_DATE - const: salesforce_number title: SALESFORCE_NUMBER - const: budget title: BUDGET - const: pacing title: PACING type: string enum: - name - id - account_id - account_name - organization_id - organization_name - status - days_remaining - start_date - end_date - salesforce_number - budget - pacing title: CampaignDashboardSortField x-enum-varnames: - NAME - ID - ACCOUNT_ID - ACCOUNT_NAME - ORGANIZATION_ID - ORGANIZATION_NAME - STATUS - DAYS_REMAINING - START_DATE - END_DATE - SALESFORCE_NUMBER - BUDGET - PACING CampaignDashboardStatus: oneOf: - const: active title: ACTIVE - const: paused title: PAUSED - const: pending title: PENDING - const: expired title: EXPIRED type: string enum: - active - paused - pending - expired title: CampaignDashboardStatus x-enum-varnames: - ACTIVE - PAUSED - PENDING - EXPIRED CampaignModel: properties: id: type: integer title: Id account_id: type: integer title: Account Id organization_id: type: integer title: Organization Id tenant_id: type: integer title: Tenant Id name: type: string title: Name start_date: type: string format: date title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date status: $ref: '#/components/schemas/Status' budget: anyOf: - type: number - type: 'null' title: Budget gross_budget: anyOf: - type: number - type: 'null' title: Gross Budget budget_padding: anyOf: - type: number - type: 'null' title: Budget Padding budget_level: $ref: '#/components/schemas/BudgetLevel' budget_type: $ref: '#/components/schemas/BudgetType' billing_source: anyOf: - $ref: '#/components/schemas/BillingSource' - type: 'null' is_cbd_enabled: type: boolean title: Is Cbd Enabled bid_type: $ref: '#/components/schemas/app__constants__BidType' is_auto_reconciliation_enabled: type: boolean title: Is Auto Reconciliation Enabled account_billing_source_id: anyOf: - type: integer - type: 'null' title: Account Billing Source Id impression_frequency_cap: anyOf: - type: integer - type: 'null' title: Impression Frequency Cap impression_frequency_cap_hours: anyOf: - type: integer - type: 'null' title: Impression Frequency Cap Hours client_io_name: anyOf: - type: string - type: 'null' title: Client Io Name client_io_number: anyOf: - type: string - type: 'null' title: Client Io Number salesforce_number: anyOf: - type: string - type: 'null' title: Salesforce Number created_date: anyOf: - type: string format: date-time - type: 'null' title: Created Date updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date is_political_inventory_enabled: type: boolean title: Is Political Inventory Enabled iab_content_category: anyOf: - type: string - type: 'null' title: Iab Content Category account_executives: items: $ref: '#/components/schemas/CampaignUserModel' type: array title: Account Executives account_managers: items: $ref: '#/components/schemas/CampaignUserModel' type: array title: Account Managers campaign_managers: items: $ref: '#/components/schemas/CampaignUserModel' type: array title: Campaign Managers publisher_domains: items: $ref: '#/components/schemas/PublisherDomainModel' type: array title: Publisher Domains app_bundles: items: $ref: '#/components/schemas/AppBundleModel' type: array title: App Bundles enable_brand_safe_publishers: type: boolean title: Enable Brand Safe Publishers default: true quickstart_step: anyOf: - type: integer - type: 'null' title: Quickstart Step type: object required: - id - account_id - organization_id - tenant_id - name - start_date - status - budget_level - budget_type - is_cbd_enabled - bid_type - is_auto_reconciliation_enabled - is_political_inventory_enabled title: CampaignModel CampaignSearchResult: properties: id: type: integer title: Id name: type: string title: Name created_date: anyOf: - type: string format: date-time - type: 'null' title: Created Date start_date: type: string format: date title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date tenant_id: type: integer title: Tenant Id tenant_name: type: string title: Tenant Name organization_id: type: integer title: Organization Id organization_name: type: string title: Organization Name account_id: type: integer title: Account Id account_name: type: string title: Account Name type: object required: - id - name - created_date - start_date - end_date - updated_date - tenant_id - tenant_name - organization_id - organization_name - account_id - account_name title: CampaignSearchResult CampaignSpendModel: properties: campaign_id: type: integer title: Campaign Id total_spend: type: number title: Total Spend default: 0.0 total_predicted_spend: type: number title: Total Predicted Spend default: 0.0 type: object required: - campaign_id title: CampaignSpendModel CampaignUserModel: properties: id: type: integer title: Id email: type: string title: Email name: type: string title: Name type: object required: - id - email - name title: CampaignUserModel CampaignsDashboardExportColumn: oneOf: - const: id title: ID - const: name title: NAME - const: status title: STATUS - const: account_id title: ACCOUNT_ID - const: account_name title: ACCOUNT_NAME - const: organization_id title: ORGANIZATION_ID - const: organization_name title: ORGANIZATION_NAME - const: salesforce_number title: SALESFORCE_NUMBER - const: start_date title: START_DATE - const: end_date title: END_DATE - const: days_remaining title: DAYS_REMAINING - const: budget title: BUDGET - const: gross_budget title: GROSS_BUDGET - const: budget_type title: BUDGET_TYPE - const: pacing title: PACING - const: impressions title: IMPRESSIONS - const: clicks title: CLICKS - const: visits title: VISITS - const: vr title: VR - const: vcr title: VCR - const: ctr title: CTR - const: daily_spend title: DAILY_SPEND - const: spends_spent title: SPEND - const: secondary_actions title: SECONDARY_ACTIONS - const: sar title: SAR - const: reach title: REACH - const: conversions title: CONVERSIONS type: string enum: - id - name - status - account_id - account_name - organization_id - organization_name - salesforce_number - start_date - end_date - days_remaining - budget - gross_budget - budget_type - pacing - impressions - clicks - visits - vr - vcr - ctr - daily_spend - spends_spent - secondary_actions - sar - reach - conversions title: CampaignsDashboardExportColumn x-enum-varnames: - ID - NAME - STATUS - ACCOUNT_ID - ACCOUNT_NAME - ORGANIZATION_ID - ORGANIZATION_NAME - SALESFORCE_NUMBER - START_DATE - END_DATE - DAYS_REMAINING - BUDGET - GROSS_BUDGET - BUDGET_TYPE - PACING - IMPRESSIONS - CLICKS - VISITS - VR - VCR - CTR - DAILY_SPEND - SPEND - SECONDARY_ACTIONS - SAR - REACH - CONVERSIONS CampaignsDashboardModel: properties: total_count: type: integer title: Total Count limit: type: integer title: Limit page_num: type: integer title: Page Num total_pages: type: integer title: Total Pages has_next_page: type: boolean title: Has Next Page has_prev_page: type: boolean title: Has Prev Page items: items: $ref: '#/components/schemas/CampaignDashboardItemModel' type: array title: Items type: object required: - total_count - limit - page_num - total_pages - has_next_page - has_prev_page - items title: CampaignsDashboardModel CampaignsModel: properties: total_count: type: integer title: Total Count limit: type: integer title: Limit page_num: type: integer title: Page Num total_pages: type: integer title: Total Pages has_next_page: type: boolean title: Has Next Page has_prev_page: type: boolean title: Has Prev Page items: items: $ref: '#/components/schemas/CampaignModel' type: array title: Items type: object required: - total_count - limit - page_num - total_pages - has_next_page - has_prev_page - items title: CampaignsModel CitiesModel: properties: items: items: $ref: '#/components/schemas/CityModel' type: array title: Items type: object required: - items title: CitiesModel CityModel: properties: name: type: string title: Name state_code: type: string title: State Code type: object required: - name - state_code title: CityModel CloneAdgroupRequestModel: properties: objective: $ref: '#/components/schemas/Objective' media_types: items: $ref: '#/components/schemas/MediaType' type: array minItems: 1 uniqueItems: true title: Media Types description: Each unique media type produces one cloned ad group with the given objective. DOOH is not supported (use DOOH-specific creation instead). type: object required: - objective - media_types title: CloneAdgroupRequestModel ClonedAdgroupsResponse: properties: adgroups: items: $ref: '#/components/schemas/AdgroupModel' type: array title: Adgroups type: object required: - adgroups title: ClonedAdgroupsResponse Community: oneOf: - const: aa title: AFRICAN_AMERICAN - const: as title: ASIAN_AMERICAN - const: hl title: HISPANIC_LATINO type: string enum: - aa - as - hl title: Community x-enum-varnames: - AFRICAN_AMERICAN - ASIAN_AMERICAN - HISPANIC_LATINO ConsolidatedDOOHApprovalStatus: oneOf: - const: 1 title: SUBMITTED - const: 2 title: INITIAL_REVIEW_APPROVED - const: 3 title: INITIAL_REVIEW_REJECTED - const: 4 title: PUBLISHER_REVIEW_APPROVED - const: 5 title: PUBLISHER_REVIEW_REJECTED type: integer enum: - 1 - 2 - 3 - 4 - 5 title: ConsolidatedDOOHApprovalStatus x-enum-varnames: - SUBMITTED - INITIAL_REVIEW_APPROVED - INITIAL_REVIEW_REJECTED - PUBLISHER_REVIEW_APPROVED - PUBLISHER_REVIEW_REJECTED CountryCode: type: string enum: - US - CA title: CountryCode CreateAccountModel: properties: name: type: string maxLength: 128 minLength: 1 title: Name country_code: $ref: '#/components/schemas/CountryCode' timezone: $ref: '#/components/schemas/Timezone' currency: $ref: '#/components/schemas/Currency' website_domain: type: string maxLength: 512 title: Website Domain vertical_id: anyOf: - $ref: '#/components/schemas/AccountVertical' - type: 'null' type: object required: - name - country_code - timezone - currency - website_domain title: CreateAccountModel CreateAccountPixelModel: properties: name: type: string maxLength: 128 minLength: 1 title: Name url: type: string maxLength: 2083 minLength: 1 format: uri title: Url enable_site_retargeting: type: boolean title: Enable Site Retargeting type: object required: - name - url - enable_site_retargeting title: CreateAccountPixelModel CreateAdPackageModel: properties: name: type: string maxLength: 256 minLength: 1 title: Name type: object required: - name title: CreateAdPackageModel CreateAdgroupModel: properties: name: type: string maxLength: 256 minLength: 1 title: Name objective: anyOf: - $ref: '#/components/schemas/Objective' - type: 'null' description: Unless you're creating an empty ad group with just a name, objective is required. Changing objective may clear targeting that does not apply to the new selection; the saved adgroup may not match your request payload. tactic: $ref: '#/components/schemas/TargetingTactic' description: 'Currently supported: DEFAULT, GEOTARGETING, ON_PREMISE, AUDIENCE, NEIGHBORHOOD' default: 0 media_types: items: $ref: '#/components/schemas/MediaType' type: array maxItems: 2 uniqueItems: true title: Media Types description: 'Currently supported: desktop, ott, audio-streaming, audio-podcast, ctv, web, app. Changing media types may clear targeting that does not apply to the new selection; the saved adgroup may not match your request payload.' bid_type: $ref: '#/components/schemas/app__api__routes__constants__BidType' default: cpm bid_price: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Bid Price default: '0' budgets: items: $ref: '#/components/schemas/BudgetModel-Input' type: array minItems: 1 title: Budgets description: You must provide at least one budget time period. The budget itself can be 0 though. audiences: anyOf: - items: $ref: '#/components/schemas/CreateUpdateAudienceModel' type: array - type: 'null' title: Audiences lookalike_audience_scale: anyOf: - $ref: '#/components/schemas/LookalikeAudienceScale' - type: 'null' deprecated: true location_filters: anyOf: - items: $ref: '#/components/schemas/LocationFilterModel-Input' type: array - type: 'null' title: Location Filters drive_to_locations: anyOf: - items: $ref: '#/components/schemas/CreateUpdateDriveToLocationModel' type: array - type: 'null' title: Drive To Locations genders: anyOf: - items: $ref: '#/components/schemas/Gender' type: array uniqueItems: true - type: 'null' title: Genders age_ranges: anyOf: - items: $ref: '#/components/schemas/AgeRange' type: array uniqueItems: true - type: 'null' title: Age Ranges enable_alcohol_age: type: boolean title: Enable Alcohol Age default: false enable_privacy_idfas: type: boolean title: Enable Privacy Idfas default: false daily_impression_cap: anyOf: - type: integer exclusiveMinimum: 0.0 - type: 'null' title: Daily Impression Cap integration_reports: anyOf: - items: $ref: '#/components/schemas/IntegrationReport' type: array uniqueItems: true - type: 'null' title: Integration Reports third_party_placement_name: anyOf: - type: string maxLength: 128 minLength: 1 - type: 'null' title: Third Party Placement Name third_party_placement_id: anyOf: - type: string maxLength: 128 minLength: 1 - type: 'null' title: Third Party Placement Id mobile_carriers: anyOf: - items: $ref: '#/components/schemas/MobileCarrierCode' type: array - type: 'null' title: Mobile Carriers income_ranges: anyOf: - items: $ref: '#/components/schemas/IncomeRange' type: array uniqueItems: true - type: 'null' title: Income Ranges communities: anyOf: - items: $ref: '#/components/schemas/Community' type: array uniqueItems: true - type: 'null' title: Communities optimization_strategy: $ref: '#/components/schemas/OptimizationStrategy' default: delivery ctr_threshold: anyOf: - type: number maximum: 0.7 minimum: 0.0 - type: 'null' title: Ctr Threshold description: Use null for system default default: 0 sar_threshold: anyOf: - type: integer maximum: 10.0 minimum: 0.0 - type: 'null' title: Sar Threshold description: Use null for system default default: 0 conversion_threshold: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' title: Conversion Threshold description: Use null for system default default: 0 psvr_threshold: anyOf: - type: number maximum: 0.99 minimum: 0.0 - type: 'null' title: Psvr Threshold description: Use null for system default default: 0 publisher_categories: anyOf: - items: $ref: '#/components/schemas/CreateUpdatePublisherCategoryModel' type: array - type: 'null' title: Publisher Categories description: This is only applicable or mobile and desktop media types streaming_video_content_categories: anyOf: - items: $ref: '#/components/schemas/CreateUpdateStreamingVideoContentCategoryModel' type: array - type: 'null' title: Streaming Video Content Categories description: This only works for CTV and OTT media types ctv_premium_categories: anyOf: - items: $ref: '#/components/schemas/CreateUpdateCTVPremiumCategoryModel' type: array - type: 'null' title: Ctv Premium Categories description: This only works for CTV media type audio_podcast_topics: anyOf: - items: $ref: '#/components/schemas/CreateUpdateAudioPodcastTopicModel' type: array - type: 'null' title: Audio Podcast Topics description: This only works for audio podcast media type audio_streaming_genres: anyOf: - items: $ref: '#/components/schemas/CreateUpdateAudioStreamingGenreModel' type: array - type: 'null' title: Audio Streaming Genres description: This only works for audio streaming media type audio_podcast_ad_positions: anyOf: - items: $ref: '#/components/schemas/AudioPodcastAdPosition' type: array uniqueItems: true - type: 'null' title: Audio Podcast Ad Positions description: This only works for audio podcast media type languages: anyOf: - items: $ref: '#/components/schemas/Language' type: array uniqueItems: true - type: 'null' title: Languages description: This only works for audio podcast and streaming media types operating_systems: anyOf: - items: $ref: '#/components/schemas/OperatingSystem' type: array uniqueItems: true - type: 'null' title: Operating Systems description: This only works for mobile media type dayparting: anyOf: - items: type: integer exclusiveMaximum: 336.0 minimum: 0.0 type: array uniqueItems: true - type: 'null' title: Dayparting description: Each number in the list represents a half hour in a week. 0 is the first half hour (12am - 12:30am) on Sunday. 335 is the last half hour (11:30pm - 12am) on Saturday. on_premise_locations: anyOf: - items: $ref: '#/components/schemas/CreateUpdateOnPremiseLocationModel' type: array - type: 'null' title: On Premise Locations neighborhoods: anyOf: - items: $ref: '#/components/schemas/CreateNeighborhoodModel' type: array - type: 'null' title: Neighborhoods neighborhood_types: anyOf: - items: $ref: '#/components/schemas/NeighborhoodType' type: array uniqueItems: true - type: 'null' title: Neighborhood Types tracking_pixels: anyOf: - items: $ref: '#/components/schemas/CreateUpdateTrackingPixelModel' type: array - type: 'null' title: Tracking Pixels billability_type: $ref: '#/components/schemas/BillabilityType' default: 0 added_cost_cpm: anyOf: - type: number minimum: 0.0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Added Cost Cpm description: Additional CPM added on top of the base bid price default: '0' viewable_percentage: anyOf: - type: integer maximum: 100.0 exclusiveMinimum: 0.0 - type: 'null' title: Viewable Percentage description: Percentage of measurable impressions that must be viewable measurable_percentage: anyOf: - type: integer maximum: 100.0 exclusiveMinimum: 0.0 - type: 'null' title: Measurable Percentage description: Percentage of impressions that must be measurable gross_bid_price: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Gross Bid Price ad_package: anyOf: - $ref: '#/components/schemas/CreateUpdateAdPackageModel' - type: 'null' description: Used to group similar ad groups budget_padding: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Budget Padding default: '0' rotate_creatives_evenly: type: boolean title: Rotate Creatives Evenly default: true pacing_mode: $ref: '#/components/schemas/PacingMode' description: Spend pacing for the ad group. Omitted defaults to standard (DEFAULT) pacing. default: 0 retargeting_segment_name: anyOf: - type: string minLength: 1 - type: 'null' title: Retargeting Segment Name description: Audience name for retargeting segment exchange_publishers: anyOf: - items: $ref: '#/components/schemas/CreatePublisherModel' type: array - type: 'null' title: Exchange Publishers custom_publishers: anyOf: - items: $ref: '#/components/schemas/CreatePublisherModel' type: array - type: 'null' title: Custom Publishers exchange_bid_type: anyOf: - $ref: '#/components/schemas/ExchangeBidType' - type: 'null' exchange_bid_price: anyOf: - anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ gt: 0 - type: 'null' title: Exchange Bid Price type: object required: - name - budgets title: CreateAdgroupModel CreateCampaignAndAdgroupsModel: properties: campaign: $ref: '#/components/schemas/CreateCampaignModel' adgroups: items: $ref: '#/components/schemas/CreateAdgroupModel' type: array title: Adgroups type: object required: - campaign title: CreateCampaignAndAdgroupsModel CreateCampaignBulkDownloadJobRequestModel: properties: campaign_ids: anyOf: - items: type: integer type: array uniqueItems: true - type: 'null' title: Campaign Ids type: object title: CreateCampaignBulkDownloadJobRequestModel CreateCampaignModel: properties: name: type: string maxLength: 256 minLength: 1 title: Name budget: anyOf: - type: number exclusiveMaximum: 1000000.0 exclusiveMinimum: 0.0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Budget budget_padding: anyOf: - type: number exclusiveMaximum: 100000000.0 minimum: 0.0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Budget Padding budget_level: $ref: '#/components/schemas/BudgetLevel' budget_type: $ref: '#/components/schemas/CampaignBudgetType' billing_source: $ref: '#/components/schemas/BillingSource' default: 1 is_auto_reconciliation_enabled: type: boolean title: Is Auto Reconciliation Enabled default: false account_billing_source_id: anyOf: - type: integer - type: 'null' title: Account Billing Source Id impression_frequency_cap: anyOf: - type: integer exclusiveMaximum: 128.0 exclusiveMinimum: 0.0 - type: 'null' title: Impression Frequency Cap impression_frequency_cap_hours: anyOf: - type: integer exclusiveMaximum: 32768.0 exclusiveMinimum: 0.0 - type: 'null' title: Impression Frequency Cap Hours client_io_name: anyOf: - type: string maxLength: 500 minLength: 1 - type: 'null' title: Client Io Name client_io_number: anyOf: - type: string maxLength: 128 minLength: 1 - type: 'null' title: Client Io Number salesforce_number: anyOf: - type: string maxLength: 16 minLength: 1 - type: 'null' title: Salesforce Number is_cbd_enabled: type: boolean title: Is Cbd Enabled default: false bid_type: $ref: '#/components/schemas/app__constants__BidType' default: CPM is_political_inventory_enabled: type: boolean title: Is Political Inventory Enabled default: false iab_content_category: anyOf: - type: string maxLength: 10 minLength: 1 - type: 'null' title: Iab Content Category account_executives: items: $ref: '#/components/schemas/CreateUpdateCampaignUserModel' type: array title: Account Executives account_managers: items: $ref: '#/components/schemas/CreateUpdateCampaignUserModel' type: array title: Account Managers campaign_managers: items: $ref: '#/components/schemas/CreateUpdateCampaignUserModel' type: array title: Campaign Managers publisher_domains: items: $ref: '#/components/schemas/PublisherDomainModel' type: array title: Publisher Domains app_bundles: items: $ref: '#/components/schemas/AppBundleModel' type: array title: App Bundles enable_brand_safe_publishers: type: boolean title: Enable Brand Safe Publishers default: true is_quickstart: type: boolean title: Is Quickstart default: false type: object required: - name - budget_level - budget_type title: CreateCampaignModel CreateCreativeModel: properties: name: anyOf: - type: string maxLength: 128 minLength: 1 - type: 'null' title: Name description: A default name will be generated for the creative if none is provided type: $ref: '#/components/schemas/CreativeType' description: 'Currently supported: IMAGE, AUDIO, SCRIPT, HTML5, VIDEO, TEXT_BANNER' click_through_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Click Through Url status: $ref: '#/components/schemas/CreativeStatus' description: INCOMPLETE status is not available default: 1 image_banner_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Image Banner Url description: Only applies to IMAGE creatives vast_tag_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Vast Tag Url description: Only applies to VIDEO and AUDIO creatives. Either `vast_tag_url` or `video_url` or `audio_url` must be used. video_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Video Url description: This value comes from `cdn_url` in the `POST /upload` response. Only applies to VIDEO creatives. Either `vast_tag_url` or `video_url` must be used. audio_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Audio Url description: Only applies to AUDIO creatives. Either `vast_tag_url` or `audio_url` must be used. script_tag: anyOf: - type: string - type: 'null' title: Script Tag description: Only applies to SCRIPT creatives size: anyOf: - type: string - type: 'null' title: Size description: Only applies to SCRIPT creatives. This is ignored for other types. api_type: $ref: '#/components/schemas/CreativeAPI' description: Only applies to IMAGE and SCRIPT creatives. This is ignored for other types. default: 0 landing_page: anyOf: - oneOf: - $ref: '#/components/schemas/StandardSuperLandingPage-Input' - $ref: '#/components/schemas/ImageLandingPage-Input' discriminator: propertyName: type mapping: '1': '#/components/schemas/StandardSuperLandingPage-Input' '2': '#/components/schemas/StandardSuperLandingPage-Input' '3': '#/components/schemas/ImageLandingPage-Input' - type: 'null' title: Landing Page description: Settings for custom GT landing page third_party_click_tracker_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Third Party Click Tracker Url description: This only applies when `landing_page` is provided. start_date: anyOf: - type: string format: date - type: 'null' title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date freq_cap_duration: anyOf: - type: integer maximum: 126.0 minimum: 1.0 - type: 'null' title: Freq Cap Duration freq_cap_value: anyOf: - type: integer maximum: 32766.0 minimum: 1.0 - type: 'null' title: Freq Cap Value interstitial: type: boolean title: Interstitial default: false rotation_weight: type: integer maximum: 32766.0 minimum: 1.0 title: Rotation Weight default: 1 image_banner_text_overlay: anyOf: - type: string - type: 'null' title: Image Banner Text Overlay description: Only applies to IMAGE creatives image_banner_text_overlay_css: anyOf: - type: string - type: 'null' title: Image Banner Text Overlay Css description: Only applies to IMAGE creatives text_banner: anyOf: - $ref: '#/components/schemas/TextBannerCreativeSettings-Input' - type: 'null' description: Only applies to TEXT_BANNER creatives. Required for that type. html5_url: anyOf: - type: string - type: 'null' title: Html5 Url description: Only applies to HTML5 creatives. And should be a zip file third_party_placement_id: anyOf: - type: string maxLength: 128 - type: 'null' title: Third Party Placement Id external_impression_urls: anyOf: - items: type: string maxLength: 2083 minLength: 1 format: uri type: array - type: 'null' title: External Impression Urls description: Third-party impression tracker URLs. external_script_urls: anyOf: - items: type: string maxLength: 2083 minLength: 1 format: uri type: array - type: 'null' title: External Script Urls description: Third-party script tracker URLs. type: object required: - type title: CreateCreativeModel CreateDoohAdgroupModel: properties: venue_type_id: type: integer title: Venue Type Id venue_type_name: type: string title: Venue Type Name publisher_id: type: string title: Publisher Id publisher_name: type: string title: Publisher Name min_bid_rate: anyOf: - type: number exclusiveMinimum: 0.0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Min Bid Rate bid_rate: anyOf: - type: number exclusiveMinimum: 0.0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Bid Rate gross_bid_rate: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Gross Bid Rate num_screens: type: integer title: Num Screens original_daily_impressions: type: integer minimum: 0.0 title: Original Daily Impressions original_budgeted_impressions: type: integer minimum: 0.0 title: Original Budgeted Impressions original_budget: anyOf: - type: number minimum: 0.0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Original Budget original_gross_budget: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Original Gross Budget creative_sizes: items: type: string type: array title: Creative Sizes examples: - - 1920x1080 - 1080x1920 type: object required: - venue_type_id - venue_type_name - publisher_id - publisher_name - min_bid_rate - bid_rate - num_screens - original_daily_impressions - original_budgeted_impressions - original_budget title: CreateDoohAdgroupModel CreateDoohAdgroupsModel: properties: adgroups: items: $ref: '#/components/schemas/CreateDoohAdgroupModel' type: array minItems: 1 title: Adgroups objective: anyOf: - $ref: '#/components/schemas/Objective' - type: 'null' description: Applied to each ad group in this request. REACH when omitted or null. default: 4 plan_data: $ref: '#/components/schemas/DOOHPlanDataModel' total_budget: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Total Budget total_gross_budget: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Total Gross Budget type: object required: - adgroups - plan_data title: CreateDoohAdgroupsModel CreateLocationFilterTargetBulkUploadJobModel: properties: input_file_url: type: string maxLength: 2083 minLength: 1 format: uri title: Input File Url type: object required: - input_file_url title: CreateLocationFilterTargetBulkUploadJobModel CreateNeighborhoodModel: properties: id: type: string title: Id type: $ref: '#/components/schemas/NeighborhoodTargetType' type: object required: - id - type title: CreateNeighborhoodModel CreateOrUpdateOrganizationModel: properties: name: type: string maxLength: 128 minLength: 1 title: Name type: object required: - name title: CreateOrUpdateOrganizationModel CreatePublisherModel: properties: id: type: integer title: Id type: object required: - id title: CreatePublisherModel CreateUpdateAdPackageModel: properties: id: type: integer title: Id type: object required: - id title: CreateUpdateAdPackageModel CreateUpdateAudienceModel: properties: id: type: string title: Id type: $ref: '#/components/schemas/AudienceType-Input' exclude: type: boolean title: Exclude default: false type: object required: - id - type title: CreateUpdateAudienceModel CreateUpdateAudioPodcastTopicModel: properties: id: type: integer title: Id type: object required: - id title: CreateUpdateAudioPodcastTopicModel CreateUpdateAudioStreamingGenreModel: properties: id: type: integer title: Id type: object required: - id title: CreateUpdateAudioStreamingGenreModel CreateUpdateCTVPremiumCategoryModel: properties: id: type: integer title: Id type: object required: - id title: CreateUpdateCTVPremiumCategoryModel CreateUpdateCampaignUserModel: properties: id: type: integer title: Id type: object required: - id title: CreateUpdateCampaignUserModel CreateUpdateDriveToLocationModel: properties: id: type: string title: Id type: $ref: '#/components/schemas/DriveToLocationType' type: object required: - id - type title: CreateUpdateDriveToLocationModel CreateUpdateOnPremiseLocationModel: properties: id: type: string title: Id type: $ref: '#/components/schemas/OnPremiseLocationType' proximity: anyOf: - $ref: '#/components/schemas/ProximityMode' - type: 'null' radius: anyOf: - type: number - type: 'null' title: Radius type: object required: - id - type title: CreateUpdateOnPremiseLocationModel CreateUpdatePublisherCategoryModel: properties: id: type: integer title: Id type: object required: - id title: CreateUpdatePublisherCategoryModel CreateUpdateStreamingVideoContentCategoryModel: properties: id: type: integer title: Id type: object required: - id title: CreateUpdateStreamingVideoContentCategoryModel CreateUpdateTrackingPixelModel: properties: id: type: integer title: Id type: object required: - id title: CreateUpdateTrackingPixelModel CreatedAdPackageModel: properties: id: type: integer title: Id name: type: string title: Name type: object required: - id - name title: CreatedAdPackageModel CreativeAPI: oneOf: - const: 0 title: NONE - const: 1 title: VPAID1 - const: 2 title: VPAID2 - const: 3 title: MRAID1 - const: 4 title: ORMMA - const: 5 title: MRAID2 type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 title: CreativeAPI x-enum-varnames: - NONE - VPAID1 - VPAID2 - MRAID1 - ORMMA - MRAID2 CreativeAssetModel: properties: id: type: integer title: Id name: type: string title: Name size: anyOf: - type: string - type: 'null' title: Size type: $ref: '#/components/schemas/CreativeAssetType' file_extension: anyOf: - type: string - type: 'null' title: File Extension source: type: string title: Source created_date: type: string format: date-time title: Created Date updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date created_by: type: string title: Created By status: $ref: '#/components/schemas/CreativeAssetStatus' type: object required: - id - name - size - type - file_extension - source - created_date - updated_date - created_by - status title: CreativeAssetModel CreativeAssetSortField: oneOf: - const: name title: NAME - const: created_date title: CREATED_DATE - const: updated_date title: UPDATED_DATE - const: asset_type title: ASSET_TYPE - const: file_extension title: FILE_EXTENSION - const: size title: SIZE type: string enum: - name - created_date - updated_date - asset_type - file_extension - size title: CreativeAssetSortField x-enum-varnames: - NAME - CREATED_DATE - UPDATED_DATE - ASSET_TYPE - FILE_EXTENSION - SIZE CreativeAssetStatus: oneOf: - const: 0 title: ACTIVE - const: 1 title: PAUSED - const: 2 title: PENDING - const: 3 title: EXPIRED - const: 4 title: UNLINKED type: integer enum: - 0 - 1 - 2 - 3 - 4 title: CreativeAssetStatus x-enum-varnames: - ACTIVE - PAUSED - PENDING - EXPIRED - UNLINKED CreativeAssetType: oneOf: - const: IMAGE title: IMAGE - const: SCRIPT title: SCRIPT - const: VIDEO title: VIDEO - const: AUDIO title: AUDIO type: string enum: - IMAGE - SCRIPT - VIDEO - AUDIO title: CreativeAssetType x-enum-varnames: - IMAGE - SCRIPT - VIDEO - AUDIO CreativeDOOHMetadata: properties: approval_status: $ref: '#/components/schemas/ConsolidatedDOOHApprovalStatus' approval_feedback: anyOf: - type: string - type: 'null' title: Approval Feedback type: object required: - approval_status title: CreativeDOOHMetadata CreativeModel: properties: id: type: integer title: Id name: type: string title: Name status: $ref: '#/components/schemas/CreativeStatus' type: $ref: '#/components/schemas/CreativeType' click_through_url: anyOf: - type: string - type: 'null' title: Click Through Url image_banner_url: anyOf: - type: string - type: 'null' title: Image Banner Url vast_tag_url: anyOf: - type: string - type: 'null' title: Vast Tag Url script_tag: anyOf: - type: string - type: 'null' title: Script Tag size: anyOf: - type: string - type: 'null' title: Size api_type: anyOf: - $ref: '#/components/schemas/CreativeAPI' - type: 'null' landing_page: anyOf: - oneOf: - $ref: '#/components/schemas/StandardSuperLandingPage-Output' - $ref: '#/components/schemas/ImageLandingPage-Output' discriminator: propertyName: type mapping: '1': '#/components/schemas/StandardSuperLandingPage-Output' '2': '#/components/schemas/StandardSuperLandingPage-Output' '3': '#/components/schemas/ImageLandingPage-Output' - type: 'null' title: Landing Page description: Settings for custom GT landing page third_party_click_tracker_url: anyOf: - type: string - type: 'null' title: Third Party Click Tracker Url description: Applies to `landing_page` on image creatives and HTML5 third-party click tracking. html5_url: anyOf: - type: string - type: 'null' title: Html5 Url description: Only applies to HTML5 creatives. external_impression_urls: anyOf: - items: type: string type: array - type: 'null' title: External Impression Urls external_script_urls: anyOf: - items: type: string type: array - type: 'null' title: External Script Urls html_tag: anyOf: - type: string - type: 'null' title: Html Tag description: Only applies to HTML5 creatives. Populated with processed banner HTML once processing is complete. start_date: anyOf: - type: string format: date - type: 'null' title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date freq_cap_duration: anyOf: - type: integer - type: 'null' title: Freq Cap Duration freq_cap_value: anyOf: - type: integer - type: 'null' title: Freq Cap Value interstitial: type: boolean title: Interstitial default: false rotation_weight: type: integer title: Rotation Weight default: 1 asset_id: anyOf: - type: integer - type: 'null' title: Asset Id thumbnail_url: anyOf: - type: string - type: 'null' title: Thumbnail Url description: Thumbnails are only available for video creatives. But not all video creatives will have them. dooh_metadata: anyOf: - $ref: '#/components/schemas/CreativeDOOHMetadata' - type: 'null' updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date blocked: type: boolean title: Blocked image_banner_text_overlay: anyOf: - type: string - type: 'null' title: Image Banner Text Overlay description: Only applies to IMAGE creatives image_banner_text_overlay_css: anyOf: - type: string - type: 'null' title: Image Banner Text Overlay Css description: Only applies to IMAGE creatives text_banner: anyOf: - $ref: '#/components/schemas/TextBannerCreativeSettings-Output' - type: 'null' description: Only applies to TEXT_BANNER creatives third_party_placement_id: anyOf: - type: string maxLength: 128 - type: 'null' title: Third Party Placement Id waymark_asset_id: anyOf: - type: string - type: 'null' title: Waymark Asset Id type: object required: - id - name - status - type - blocked title: CreativeModel CreativeSearchResult: properties: id: type: integer title: Id name: type: string title: Name start_date: anyOf: - type: string format: date - type: 'null' title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date tenant_id: type: integer title: Tenant Id tenant_name: type: string title: Tenant Name organization_id: type: integer title: Organization Id organization_name: type: string title: Organization Name account_id: type: integer title: Account Id account_name: type: string title: Account Name campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name adgroup_id: type: integer title: Adgroup Id adgroup_name: type: string title: Adgroup Name type: object required: - id - name - start_date - end_date - updated_date - tenant_id - tenant_name - organization_id - organization_name - account_id - account_name - campaign_id - campaign_name - adgroup_id - adgroup_name title: CreativeSearchResult CreativeStatus: oneOf: - const: 1 title: ACTIVE - const: 2 title: PAUSED - const: 7 title: INCOMPLETE type: integer enum: - 1 - 2 - 7 title: CreativeStatus x-enum-varnames: - ACTIVE - PAUSED - INCOMPLETE CreativeType: oneOf: - const: IMAGE title: IMAGE - const: HTML5 title: HTML5 - const: SCRIPT title: SCRIPT - const: VIDEO title: VIDEO - const: TEXT_BANNER title: TEXT_BANNER - const: AUDIO title: AUDIO type: string enum: - IMAGE - HTML5 - SCRIPT - VIDEO - TEXT_BANNER - AUDIO title: CreativeType x-enum-varnames: - IMAGE - HTML5 - SCRIPT - VIDEO - TEXT_BANNER - AUDIO CreativesModel: properties: total_count: type: integer title: Total Count limit: type: integer title: Limit page_num: type: integer title: Page Num total_pages: type: integer title: Total Pages has_next_page: type: boolean title: Has Next Page has_prev_page: type: boolean title: Has Prev Page items: items: $ref: '#/components/schemas/CreativeModel' type: array title: Items type: object required: - total_count - limit - page_num - total_pages - has_next_page - has_prev_page - items title: CreativesModel CtvNetworkRowModel: properties: campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id description: Campaign ID (present for campaign-level) campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name description: Campaign name (present for campaign-level) adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID (present for adgroup-level) adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name (present for adgroup-level) network_name: type: string title: Network Name description: Network or channel name imp: type: integer title: Imp description: Total impressions vid_0: anyOf: - type: integer - type: 'null' title: Vid 0 description: Video start (first frame) count vid_25: anyOf: - type: integer - type: 'null' title: Vid 25 description: Video first quartile (25%%) count vid_50: anyOf: - type: integer - type: 'null' title: Vid 50 description: Video midpoint (50%%) count vid_75: anyOf: - type: integer - type: 'null' title: Vid 75 description: Video third quartile (75%%) count vid_100: anyOf: - type: integer - type: 'null' title: Vid 100 description: Video end (100%%) count vcr: type: number title: Vcr description: Video completion rate (video_end / video_start) type: object required: - network_name - imp - vcr title: CtvNetworkRowModel description: Single row for CTV/OTT network bundle (campaign, adgroup, or campaign adgroups). CtvNetworkSortByFieldName: oneOf: - const: imp title: IMP description: Allowed sort_by values for CTV network bundle endpoints (maps to query column names). - const: vid_0 title: VID_0 description: Allowed sort_by values for CTV network bundle endpoints (maps to query column names). - const: vid_25 title: VID_25 description: Allowed sort_by values for CTV network bundle endpoints (maps to query column names). - const: vid_50 title: VID_50 description: Allowed sort_by values for CTV network bundle endpoints (maps to query column names). - const: vid_75 title: VID_75 description: Allowed sort_by values for CTV network bundle endpoints (maps to query column names). - const: vid_100 title: VID_100 description: Allowed sort_by values for CTV network bundle endpoints (maps to query column names). - const: vcr title: VCR description: Allowed sort_by values for CTV network bundle endpoints (maps to query column names). type: string enum: - imp - vid_0 - vid_25 - vid_50 - vid_75 - vid_100 - vcr title: CtvNetworkSortByFieldName description: Allowed sort_by values for CTV network bundle endpoints (maps to query column names). x-enum-varnames: - IMP - VID_0 - VID_25 - VID_50 - VID_75 - VID_100 - VCR CtvOttAdgroupPerformanceModel: properties: adgroup_id: type: integer title: Adgroup Id adgroup_name: type: string title: Adgroup Name report_summary: $ref: '#/components/schemas/CtvOttReportSummaryModel' publishers: items: $ref: '#/components/schemas/CtvOttPublisherSummaryModel' type: array title: Publishers devices: items: $ref: '#/components/schemas/CtvOttDeviceSummaryModel' type: array title: Devices showcased_videos: items: type: string type: array title: Showcased Videos type: object required: - adgroup_id - adgroup_name - report_summary - publishers - devices - showcased_videos title: CtvOttAdgroupPerformanceModel CtvOttCampaignPerformanceModel: properties: campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name report_summary: $ref: '#/components/schemas/CtvOttReportSummaryModel' publishers: items: $ref: '#/components/schemas/CtvOttPublisherSummaryModel' type: array title: Publishers devices: items: $ref: '#/components/schemas/CtvOttDeviceSummaryModel' type: array title: Devices showcased_videos: items: type: string type: array title: Showcased Videos type: object required: - campaign_id - campaign_name - report_summary - publishers - devices - showcased_videos title: CtvOttCampaignPerformanceModel CtvOttCampaignSortByFieldName: oneOf: - const: impressions title: IMPRESSIONS - const: tv_imps title: TV_IMPS - const: mobile_imps title: MOBILE_IMPS - const: desktop_imps title: DESKTOP_IMPS - const: tablet_imps title: TABLET_IMPS - const: vcr title: VCR type: string enum: - impressions - tv_imps - mobile_imps - desktop_imps - tablet_imps - vcr title: CtvOttCampaignSortByFieldName x-enum-varnames: - IMPRESSIONS - TV_IMPS - MOBILE_IMPS - DESKTOP_IMPS - TABLET_IMPS - VCR CtvOttDeviceSummaryModel: properties: device: type: string title: Device impressions: type: number title: Impressions vcr: type: number title: Vcr description: Video completion rate type: object required: - device - impressions - vcr title: CtvOttDeviceSummaryModel CtvOttNetworkSummaryModel: properties: network_name: type: string title: Network Name tv_imps: type: number title: Tv Imps mobile_imps: type: number title: Mobile Imps desktop_imps: type: number title: Desktop Imps tablet_imps: type: number title: Tablet Imps impressions: type: number title: Impressions vcr: type: number title: Vcr description: Video completion rate logo_url: type: string title: Logo Url type: object required: - network_name - tv_imps - mobile_imps - desktop_imps - tablet_imps - impressions - vcr - logo_url title: CtvOttNetworkSummaryModel CtvOttPublisherSummaryModel: properties: app_name: type: string title: App Name tv_imps: type: number title: Tv Imps mobile_imps: type: number title: Mobile Imps desktop_imps: type: number title: Desktop Imps tablet_imps: type: number title: Tablet Imps impressions: type: number title: Impressions vcr: type: number title: Vcr description: Video completion rate logo_url: type: string title: Logo Url has_channels: type: boolean title: Has Channels networks: items: $ref: '#/components/schemas/CtvOttNetworkSummaryModel' type: array title: Networks type: object required: - app_name - tv_imps - mobile_imps - desktop_imps - tablet_imps - impressions - vcr - logo_url - has_channels - networks title: CtvOttPublisherSummaryModel CtvOttReportSummaryModel: properties: impressions: type: number title: Impressions video_start: type: number title: Video Start video_completion: type: number title: Video Completion visits: type: number title: Visits vcr: type: number title: Vcr description: Video completion rate reach: type: number title: Reach time_on_screen: type: number title: Time On Screen frequency: type: number title: Frequency coview_reach: anyOf: - type: integer - type: 'null' title: Coview Reach type: object required: - impressions - video_start - video_completion - visits - vcr - reach - time_on_screen - frequency title: CtvOttReportSummaryModel CtvPublisherAdgroupModel: properties: publisher_name: type: string title: Publisher Name description: Name of the CTV/OTT publisher or app logo_url: anyOf: - type: string - type: 'null' title: Logo Url description: URL to the publisher logo image impressions: type: integer title: Impressions description: Total number of impressions tv_imp_proportion: type: number title: Tv Imp Proportion description: Proportion of impressions served on TV devices (0.0 to 1.0) mobile_imp_proportion: type: number title: Mobile Imp Proportion description: Proportion of impressions served on mobile/phone devices (0.0 to 1.0) desktop_imp_proportion: type: number title: Desktop Imp Proportion description: Proportion of impressions served on desktop devices (0.0 to 1.0) tablet_imp_proportion: type: number title: Tablet Imp Proportion description: Proportion of impressions served on tablet devices (0.0 to 1.0) vid_0: anyOf: - type: integer - type: 'null' title: Vid 0 description: Number of videos that started playing vid_25: anyOf: - type: integer - type: 'null' title: Vid 25 description: Number of videos that reached 25% completion (first quartile) vid_50: anyOf: - type: integer - type: 'null' title: Vid 50 description: Number of videos that reached 50% completion (midpoint) vid_75: anyOf: - type: integer - type: 'null' title: Vid 75 description: Number of videos that reached 75% completion (third quartile) vid_100: anyOf: - type: integer - type: 'null' title: Vid 100 description: Number of videos that completed 100% (video end) vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate, calculated as vid_100 / vid_0 (0.0 to 1.0) networks: items: $ref: '#/components/schemas/CtvPublisherNetworkModel' type: array title: Networks description: List of channels (or networks when channel data is unavailable) associated with this publisher. Empty if the publisher does not support channel/network breakdown. type: object required: - publisher_name - impressions - tv_imp_proportion - mobile_imp_proportion - desktop_imp_proportion - tablet_imp_proportion - networks title: CtvPublisherAdgroupModel CtvPublisherCampaignAdgroupsModel: properties: adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name publisher_name: type: string title: Publisher Name description: Name of the CTV/OTT publisher or app logo_url: anyOf: - type: string - type: 'null' title: Logo Url description: URL to the publisher logo image impressions: type: integer title: Impressions description: Total number of impressions tv_imp_proportion: type: number title: Tv Imp Proportion description: Proportion of impressions served on TV devices (0.0 to 1.0) mobile_imp_proportion: type: number title: Mobile Imp Proportion description: Proportion of impressions served on mobile/phone devices (0.0 to 1.0) desktop_imp_proportion: type: number title: Desktop Imp Proportion description: Proportion of impressions served on desktop devices (0.0 to 1.0) tablet_imp_proportion: type: number title: Tablet Imp Proportion description: Proportion of impressions served on tablet devices (0.0 to 1.0) vid_0: anyOf: - type: integer - type: 'null' title: Vid 0 description: Number of videos that started playing vid_25: anyOf: - type: integer - type: 'null' title: Vid 25 description: Number of videos that reached 25% completion (first quartile) vid_50: anyOf: - type: integer - type: 'null' title: Vid 50 description: Number of videos that reached 50% completion (midpoint) vid_75: anyOf: - type: integer - type: 'null' title: Vid 75 description: Number of videos that reached 75% completion (third quartile) vid_100: anyOf: - type: integer - type: 'null' title: Vid 100 description: Number of videos that completed 100% (video end) vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate, calculated as vid_100 / vid_0 (0.0 to 1.0) networks: items: $ref: '#/components/schemas/CtvPublisherNetworkModel' type: array title: Networks description: List of channels (or networks when channel data is unavailable) associated with this publisher. Empty if the publisher does not support channel/network breakdown. type: object required: - adgroup_id - adgroup_name - publisher_name - impressions - tv_imp_proportion - mobile_imp_proportion - desktop_imp_proportion - tablet_imp_proportion - networks title: CtvPublisherCampaignAdgroupsModel CtvPublisherNetworkModel: properties: network_name: type: string title: Network Name description: Name of the channel or network (channels are preferred when available) logo_url: anyOf: - type: string - type: 'null' title: Logo Url description: URL to the network logo image tv_imp_proportion: type: number title: Tv Imp Proportion description: Proportion of impressions served on TV devices (0.0 to 1.0) mobile_imp_proportion: type: number title: Mobile Imp Proportion description: Proportion of impressions served on mobile/phone devices (0.0 to 1.0) desktop_imp_proportion: type: number title: Desktop Imp Proportion description: Proportion of impressions served on desktop devices (0.0 to 1.0) tablet_imp_proportion: type: number title: Tablet Imp Proportion description: Proportion of impressions served on tablet devices (0.0 to 1.0) impressions: type: integer title: Impressions description: Total number of impressions vid_0: anyOf: - type: integer - type: 'null' title: Vid 0 description: Number of videos that started playing vid_25: anyOf: - type: integer - type: 'null' title: Vid 25 description: Number of videos that reached 25% completion (first quartile) vid_50: anyOf: - type: integer - type: 'null' title: Vid 50 description: Number of videos that reached 50% completion (midpoint) vid_75: anyOf: - type: integer - type: 'null' title: Vid 75 description: Number of videos that reached 75% completion (third quartile) vid_100: anyOf: - type: integer - type: 'null' title: Vid 100 description: Number of videos that completed 100% (video end) vcr: type: number title: Vcr description: Video completion rate, calculated as vid_100 / vid_0 (0.0 to 1.0) type: object required: - network_name - tv_imp_proportion - mobile_imp_proportion - desktop_imp_proportion - tablet_imp_proportion - impressions - vcr title: CtvPublisherNetworkModel Currency: oneOf: - const: USD title: USD - const: CAD title: CAD type: string enum: - USD - CAD title: Currency x-enum-varnames: - USD - CAD DMAModel: properties: code: type: string title: Code name: type: string title: Name type: object required: - code - name title: DMAModel DMAsModel: properties: items: items: $ref: '#/components/schemas/DMAModel' type: array title: Items type: object required: - items title: DMAsModel DOOHAdgroupIDsModel: properties: adgroup_ids: items: type: integer type: array title: Adgroup Ids type: object required: - adgroup_ids title: DOOHAdgroupIDsModel DOOHCreativeFormat: oneOf: - const: image title: IMAGE - const: video title: VIDEO - const: audio title: AUDIO type: string enum: - image - video - audio title: DOOHCreativeFormat x-enum-varnames: - IMAGE - VIDEO - AUDIO DOOHDistanceUnit: oneOf: - const: miles title: MILES - const: feet title: FEET type: string enum: - miles - feet title: DOOHDistanceUnit x-enum-varnames: - MILES - FEET DOOHGeoCityModel: properties: exclude: type: boolean title: Exclude name: type: string title: Name type: type: string const: city title: Type id: type: integer title: Id city: type: string title: City state: type: string title: State type: object required: - exclude - name - type - id - city - state title: DOOHGeoCityModel DOOHGeoCountyModel: properties: exclude: type: boolean title: Exclude name: type: string title: Name type: type: string const: county title: Type county_fips: type: string title: County Fips type: object required: - exclude - name - type - county_fips title: DOOHGeoCountyModel DOOHGeoDmaModel: properties: exclude: type: boolean title: Exclude name: type: string title: Name type: type: string const: dma title: Type dmacode: type: integer title: Dmacode type: object required: - exclude - name - type - dmacode title: DOOHGeoDmaModel DOOHGeoLocationGroupModel: properties: id: type: integer title: Id distance_unit: $ref: '#/components/schemas/DOOHDistanceUnit' distance: type: number title: Distance exclude: type: boolean title: Exclude default: false type: object required: - id - distance_unit - distance title: DOOHGeoLocationGroupModel DOOHGeoStateModel: properties: exclude: type: boolean title: Exclude name: type: string title: Name type: type: string const: state title: Type id: type: integer title: Id state: type: string title: State type: object required: - exclude - name - type - id - state title: DOOHGeoStateModel DOOHGeoZipcodeModel: properties: exclude: type: boolean title: Exclude name: type: string title: Name type: type: string const: zip_code title: Type zipcode: type: string title: Zipcode type: object required: - exclude - name - type - zipcode title: DOOHGeoZipcodeModel DOOHMetadataModel: properties: venue_type_id: type: integer title: Venue Type Id publisher_name: anyOf: - type: string - type: 'null' title: Publisher Name num_screens: type: integer title: Num Screens num_ad_units: type: integer title: Num Ad Units ad_specs: additionalProperties: true type: object title: Ad Specs venue_type: anyOf: - type: string - type: 'null' title: Venue Type type: object required: - venue_type_id - num_screens - num_ad_units - ad_specs title: DOOHMetadataModel DOOHPlanDataModel: properties: creative_formats: items: $ref: '#/components/schemas/DOOHCreativeFormat' type: array title: Creative Formats creative_sizes: items: type: string type: array title: Creative Sizes examples: - - 1920x1080 - 1080x1920 location_groups: items: $ref: '#/components/schemas/DOOHGeoLocationGroupModel' type: array title: Location Groups locations: items: oneOf: - $ref: '#/components/schemas/DOOHGeoCityModel' - $ref: '#/components/schemas/DOOHGeoStateModel' - $ref: '#/components/schemas/DOOHGeoZipcodeModel' - $ref: '#/components/schemas/DOOHGeoDmaModel' - $ref: '#/components/schemas/DOOHGeoCountyModel' discriminator: propertyName: type mapping: city: '#/components/schemas/DOOHGeoCityModel' county: '#/components/schemas/DOOHGeoCountyModel' dma: '#/components/schemas/DOOHGeoDmaModel' state: '#/components/schemas/DOOHGeoStateModel' zip_code: '#/components/schemas/DOOHGeoZipcodeModel' type: array title: Locations publishers: items: $ref: '#/components/schemas/DOOHPublisherModel' type: array title: Publishers venue_types: items: $ref: '#/components/schemas/DOOHVenueTypeModel' type: array title: Venue Types start_date: type: string format: date title: Start Date end_date: type: string format: date title: End Date iab_code: type: string title: Iab Code account_domain: type: string title: Account Domain type: object required: - creative_formats - location_groups - locations - publishers - venue_types - start_date - end_date - iab_code - account_domain title: DOOHPlanDataModel DOOHPublisherModel: properties: id: type: string title: Id exclude: type: boolean title: Exclude type: object required: - id - exclude title: DOOHPublisherModel DOOHVenueTypeModel: properties: exclude: type: boolean title: Exclude id: type: integer title: Id type: object required: - exclude - id title: DOOHVenueTypeModel DailyMetricsAdgroupModel: properties: forecasted: anyOf: - type: integer - type: 'null' title: Forecasted date: anyOf: - type: string - type: 'null' title: Date account_name: anyOf: - type: string - type: 'null' title: Account Name campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name impressions: anyOf: - type: integer - type: 'null' title: Impressions clicks: anyOf: - type: integer - type: 'null' title: Clicks spend: anyOf: - type: number - type: 'null' title: Spend pacing: anyOf: - type: number - type: 'null' title: Pacing ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate cpm: anyOf: - type: number - type: 'null' title: Cpm total_sa: anyOf: - type: number - type: 'null' title: Total Sa sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate click_to_call: anyOf: - type: number - type: 'null' title: Click To Call directions: anyOf: - type: number - type: 'null' title: Directions website: anyOf: - type: number - type: 'null' title: Website moreinfo: anyOf: - type: number - type: 'null' title: Moreinfo coupon: anyOf: - type: number - type: 'null' title: Coupon video: anyOf: - type: number - type: 'null' title: Video daily_reach: anyOf: - type: integer - type: 'null' title: Daily Reach cumulative_reach: anyOf: - type: integer - type: 'null' title: Cumulative Reach visits: anyOf: - type: integer - type: 'null' title: Visits visitors: anyOf: - type: integer - type: 'null' title: Visitors oh_vst: anyOf: - type: integer - type: 'null' title: Oh Vst description: Total open hour visits oh_visitors: anyOf: - type: integer - type: 'null' title: Oh Visitors description: Total open hour visitors prj_vst: anyOf: - type: integer - type: 'null' title: Prj Vst description: Projected visits svr: anyOf: - type: number - type: 'null' title: Svr svl: anyOf: - type: number - type: 'null' title: Svl video_start: anyOf: - type: number - type: 'null' title: Video Start video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile video_end: anyOf: - type: number - type: 'null' title: Video End conversions: anyOf: - type: number - type: 'null' title: Conversions vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate daily_coview_reach: anyOf: - type: integer - type: 'null' title: Daily Coview Reach cumulative_coview_reach: anyOf: - type: integer - type: 'null' title: Cumulative Coview Reach daily_colisten_reach: anyOf: - type: integer - type: 'null' title: Daily Colisten Reach cumulative_colisten_reach: anyOf: - type: integer - type: 'null' title: Cumulative Colisten Reach type: object title: DailyMetricsAdgroupModel DailyMetricsCampaignAdgroupsModel: properties: date: anyOf: - type: string - type: 'null' title: Date account_name: anyOf: - type: string - type: 'null' title: Account Name campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name adgroup_start_date: anyOf: - type: string - type: 'null' title: Adgroup Start Date adgroup_end_date: anyOf: - type: string - type: 'null' title: Adgroup End Date adgroup_status: anyOf: - type: string - type: 'null' title: Adgroup Status adv_bid_type: anyOf: - type: string - type: 'null' title: Adv Bid Type budget_type: anyOf: - type: string - type: 'null' title: Budget Type impressions: anyOf: - type: integer - type: 'null' title: Impressions clicks: anyOf: - type: integer - type: 'null' title: Clicks spend: anyOf: - type: number - type: 'null' title: Spend ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate cpm: anyOf: - type: number - type: 'null' title: Cpm total_sa: anyOf: - type: number - type: 'null' title: Total Sa sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate click_to_call: anyOf: - type: number - type: 'null' title: Click To Call directions: anyOf: - type: number - type: 'null' title: Directions website: anyOf: - type: number - type: 'null' title: Website moreinfo: anyOf: - type: number - type: 'null' title: Moreinfo coupon: anyOf: - type: number - type: 'null' title: Coupon video: anyOf: - type: number - type: 'null' title: Video daily_reach: anyOf: - type: integer - type: 'null' title: Daily Reach cumulative_reach: anyOf: - type: integer - type: 'null' title: Cumulative Reach daily_coview_reach: anyOf: - type: integer - type: 'null' title: Daily Coview Reach daily_colisten_reach: anyOf: - type: integer - type: 'null' title: Daily Colisten Reach cumulative_coview_reach: anyOf: - type: integer - type: 'null' title: Cumulative Coview Reach cumulative_colisten_reach: anyOf: - type: integer - type: 'null' title: Cumulative Colisten Reach visits: anyOf: - type: integer - type: 'null' title: Visits visitors: anyOf: - type: integer - type: 'null' title: Visitors oh_vst: anyOf: - type: integer - type: 'null' title: Oh Vst description: Total open hour visits oh_visitors: anyOf: - type: integer - type: 'null' title: Oh Visitors description: Total open hour visitors prj_vst: anyOf: - type: integer - type: 'null' title: Prj Vst description: Projected visits svr: anyOf: - type: number - type: 'null' title: Svr svl: anyOf: - type: number - type: 'null' title: Svl video_start: anyOf: - type: number - type: 'null' title: Video Start description: Number of videos that started playing video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile description: Number of videos that reached 25% completion (first quartile) video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint description: Number of videos that reached 50% completion (midpoint) video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile description: Number of videos that reached 75% completion (third quartile) video_end: anyOf: - type: number - type: 'null' title: Video End description: Number of videos that completed 100% (video end) vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate conversions: anyOf: - type: number - type: 'null' title: Conversions ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate type: object title: DailyMetricsCampaignAdgroupsModel DailyMetricsCampaignAdgroupsResponseModel: properties: daily_metrics: items: $ref: '#/components/schemas/DailyMetricsCampaignAdgroupsModel' type: array title: Daily Metrics adgroups_today_spend: items: $ref: '#/components/schemas/AdgroupsTodaySpendModel' type: array title: Adgroups Today Spend date: anyOf: - type: string format: date - type: 'null' title: Date description: Current date in the ad group's timezone type: object required: - daily_metrics - adgroups_today_spend title: DailyMetricsCampaignAdgroupsResponseModel DailyMetricsCampaignCreativesModel: properties: date: anyOf: - type: string - type: 'null' title: Date organization_name: anyOf: - type: string - type: 'null' title: Organization Name account_id: anyOf: - type: integer - type: 'null' title: Account Id account_name: anyOf: - type: string - type: 'null' title: Account Name campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name campaign_start_date: anyOf: - type: string - type: 'null' title: Campaign Start Date campaign_end_date: anyOf: - type: string - type: 'null' title: Campaign End Date adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name creative_id: anyOf: - type: integer - type: 'null' title: Creative Id creative_name: anyOf: - type: string - type: 'null' title: Creative Name creative_size: anyOf: - type: string - type: 'null' title: Creative Size creative_url: anyOf: - type: string - type: 'null' title: Creative Url advertiser_bid_type: anyOf: - type: string - type: 'null' title: Advertiser Bid Type budget_type: anyOf: - type: string - type: 'null' title: Budget Type market: anyOf: - type: string - type: 'null' title: Market contract_id: anyOf: - type: string - type: 'null' title: Contract Id campaign_budget: anyOf: - type: number - type: 'null' title: Campaign Budget total_imp_contracted: anyOf: - type: integer - type: 'null' title: Total Imp Contracted external_adgroup_id: anyOf: - type: string - type: 'null' title: External Adgroup Id impressions: anyOf: - type: integer - type: 'null' title: Impressions clicks: anyOf: - type: integer - type: 'null' title: Clicks spend: anyOf: - type: number - type: 'null' title: Spend ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate cpm: anyOf: - type: number - type: 'null' title: Cpm cpv: anyOf: - type: number - type: 'null' title: Cpv total_sa: anyOf: - type: number - type: 'null' title: Total Sa sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate click_to_call: anyOf: - type: number - type: 'null' title: Click To Call directions: anyOf: - type: number - type: 'null' title: Directions website: anyOf: - type: number - type: 'null' title: Website moreinfo: anyOf: - type: number - type: 'null' title: Moreinfo coupon: anyOf: - type: number - type: 'null' title: Coupon video: anyOf: - type: number - type: 'null' title: Video daily_reach: anyOf: - type: integer - type: 'null' title: Daily Reach cumulative_reach: anyOf: - type: integer - type: 'null' title: Cumulative Reach visits: anyOf: - type: integer - type: 'null' title: Visits visitors: anyOf: - type: integer - type: 'null' title: Visitors oh_vst: anyOf: - type: integer - type: 'null' title: Oh Vst description: Total open hour visits oh_visitors: anyOf: - type: integer - type: 'null' title: Oh Visitors description: Total open hour visitors prj_vst: anyOf: - type: integer - type: 'null' title: Prj Vst description: Projected visits svr: anyOf: - type: number - type: 'null' title: Svr svl: anyOf: - type: number - type: 'null' title: Svl video_start: anyOf: - type: number - type: 'null' title: Video Start video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile video_end: anyOf: - type: number - type: 'null' title: Video End vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate type: object title: DailyMetricsCampaignCreativesModel DailyMetricsCampaignModel: properties: forecasted: anyOf: - type: integer - type: 'null' title: Forecasted date: anyOf: - type: string - type: 'null' title: Date account_name: anyOf: - type: string - type: 'null' title: Account Name campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name campaign_start_date: anyOf: - type: string - type: 'null' title: Campaign Start Date campaign_end_date: anyOf: - type: string - type: 'null' title: Campaign End Date budget_type: anyOf: - type: string - type: 'null' title: Budget Type adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name impressions: anyOf: - type: integer - type: 'null' title: Impressions clicks: anyOf: - type: integer - type: 'null' title: Clicks spend: anyOf: - type: number - type: 'null' title: Spend pacing: anyOf: - type: number - type: 'null' title: Pacing ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate cpm: anyOf: - type: number - type: 'null' title: Cpm total_sa: anyOf: - type: number - type: 'null' title: Total Sa sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate click_to_call: anyOf: - type: number - type: 'null' title: Click To Call directions: anyOf: - type: number - type: 'null' title: Directions website: anyOf: - type: number - type: 'null' title: Website moreinfo: anyOf: - type: number - type: 'null' title: Moreinfo coupon: anyOf: - type: number - type: 'null' title: Coupon video: anyOf: - type: number - type: 'null' title: Video daily_reach: anyOf: - type: integer - type: 'null' title: Daily Reach cumulative_reach: anyOf: - type: integer - type: 'null' title: Cumulative Reach daily_coview_reach: anyOf: - type: integer - type: 'null' title: Daily Coview Reach daily_colisten_reach: anyOf: - type: integer - type: 'null' title: Daily Colisten Reach cumulative_coview_reach: anyOf: - type: integer - type: 'null' title: Cumulative Coview Reach cumulative_colisten_reach: anyOf: - type: integer - type: 'null' title: Cumulative Colisten Reach visits: anyOf: - type: integer - type: 'null' title: Visits visitors: anyOf: - type: integer - type: 'null' title: Visitors oh_vst: anyOf: - type: integer - type: 'null' title: Oh Vst description: Total open hour visits oh_visitors: anyOf: - type: integer - type: 'null' title: Oh Visitors description: Total open hour visitors prj_vst: anyOf: - type: integer - type: 'null' title: Prj Vst description: Projected visits svr: anyOf: - type: number - type: 'null' title: Svr svl: anyOf: - type: number - type: 'null' title: Svl video_start: anyOf: - type: number - type: 'null' title: Video Start video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile video_end: anyOf: - type: number - type: 'null' title: Video End conversions: anyOf: - type: number - type: 'null' title: Conversions vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate total_sales: anyOf: - type: number - type: 'null' title: Total Sales avg_sales: anyOf: - type: number - type: 'null' title: Avg Sales type: object title: DailyMetricsCampaignModel DailyMetricsCreativeModel: properties: date: anyOf: - type: string - type: 'null' title: Date account_name: anyOf: - type: string - type: 'null' title: Account Name campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name creative_id: anyOf: - type: integer - type: 'null' title: Creative Id creative_name: anyOf: - type: string - type: 'null' title: Creative Name impressions: anyOf: - type: integer - type: 'null' title: Impressions clicks: anyOf: - type: integer - type: 'null' title: Clicks spend: anyOf: - type: number - type: 'null' title: Spend ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate cpm: anyOf: - type: number - type: 'null' title: Cpm total_sa: anyOf: - type: number - type: 'null' title: Total Sa sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate click_to_call: anyOf: - type: number - type: 'null' title: Click To Call directions: anyOf: - type: number - type: 'null' title: Directions website: anyOf: - type: number - type: 'null' title: Website moreinfo: anyOf: - type: number - type: 'null' title: Moreinfo coupon: anyOf: - type: number - type: 'null' title: Coupon video: anyOf: - type: number - type: 'null' title: Video daily_reach: anyOf: - type: integer - type: 'null' title: Daily Reach cumulative_reach: anyOf: - type: integer - type: 'null' title: Cumulative Reach visits: anyOf: - type: integer - type: 'null' title: Visits visitors: anyOf: - type: integer - type: 'null' title: Visitors oh_vst: anyOf: - type: integer - type: 'null' title: Oh Vst description: Total open hour visits oh_visitors: anyOf: - type: integer - type: 'null' title: Oh Visitors description: Total open hour visitors prj_vst: anyOf: - type: integer - type: 'null' title: Prj Vst description: Projected visits svr: anyOf: - type: number - type: 'null' title: Svr svl: anyOf: - type: number - type: 'null' title: Svl video_start: anyOf: - type: number - type: 'null' title: Video Start video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile video_end: anyOf: - type: number - type: 'null' title: Video End vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object title: DailyMetricsCreativeModel DartBillingAccount: properties: account_id: type: string title: Account Id account_name: type: string title: Account Name type: object required: - account_id - account_name title: DartBillingAccount DemographicsPartialAgeModel: properties: age: type: string title: Age description: Age bracket key imp: anyOf: - type: integer - type: 'null' title: Imp description: Impressions vst: anyOf: - type: integer - type: 'null' title: Vst description: Visits clks: anyOf: - type: integer - type: 'null' title: Clks description: Clicks ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate rch: anyOf: - type: integer - type: 'null' title: Rch description: Reach vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate type: object required: - age title: DemographicsPartialAgeModel DemographicsPartialGenderModel: properties: gdr: type: string title: Gdr description: Gender key ("m", "f", or "-1" for unknown) ages: items: $ref: '#/components/schemas/DemographicsPartialAgeModel' type: array title: Ages description: Metrics by age bracket type: object required: - gdr - ages title: DemographicsPartialGenderModel DetailedAudienceCategory: properties: name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description audiences: items: $ref: '#/components/schemas/Audience' type: array title: Audiences size: anyOf: - type: integer - type: 'null' title: Size category_id: anyOf: - type: integer - type: 'null' title: Category Id type: object required: - name - description - audiences title: DetailedAudienceCategory DoohCampaignV1PaginationModel: properties: next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: Opaque cursor for the next page. Null when this is the final page. type: object title: DoohCampaignV1PaginationModel description: Cursor-based pagination envelope. DoohCampaignV1ResponseModel: properties: request_id: type: string title: Request Id description: UUID for tracing this request end-to-end summary: $ref: '#/components/schemas/DoohCampaignV1SummaryModel' results: items: $ref: '#/components/schemas/DoohCampaignV1RowModel' type: array title: Results pagination: $ref: '#/components/schemas/DoohCampaignV1PaginationModel' type: object required: - request_id - summary - results - pagination title: DoohCampaignV1ResponseModel description: Top-level response shape for GET /dooh/v1/campaign/{campaign_id}. DoohCampaignV1RowMetricsModel: properties: impressions: type: integer title: Impressions description: Total impressions default: 0 spend: type: number title: Spend description: Total spend default: 0.0 plays: type: integer title: Plays description: Total ad plays before impression multiplier default: 0 visits: anyOf: - type: integer - type: 'null' title: Visits description: Attributed store visits. Null when not available at this slice grain, such as ad_unit_id. reach: anyOf: - type: integer - type: 'null' title: Reach description: Deterministic reach. Null unless available at the exact slice grain. projected_reach: anyOf: - type: integer - type: 'null' title: Projected Reach description: Modeled projected reach. Null unless available at the exact slice grain. type: object title: DoohCampaignV1RowMetricsModel description: Per-row metric values. DoohCampaignV1RowModel: properties: dimensions: additionalProperties: anyOf: - type: string - type: integer - type: 'null' type: object title: Dimensions metrics: $ref: '#/components/schemas/DoohCampaignV1RowMetricsModel' type: object required: - dimensions - metrics title: DoohCampaignV1RowModel description: One row in the `results` array. DoohCampaignV1SummaryModel: properties: impressions: type: integer title: Impressions description: Campaign-level total impressions default: 0 spend: type: number title: Spend description: Campaign-level total spend default: 0.0 plays: type: integer title: Plays description: Campaign-level total ad plays before impression multiplier default: 0 visits: anyOf: - type: integer - type: 'null' title: Visits description: Total attributed store visits (null when unavailable) reach: anyOf: - type: integer - type: 'null' title: Reach description: Campaign-level deterministic reach (null when unavailable) projected_reach: anyOf: - type: integer - type: 'null' title: Projected Reach description: Campaign-level projected reach (null when unavailable) type: object title: DoohCampaignV1SummaryModel description: Campaign-level totals for the selected date range. DoohPublisherCampaignResponseModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID, present when all_adgroups or all_creatives adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name, present when all_adgroups or all_creatives creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID, present when all_creatives creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name, present when all_creatives publisher: type: string title: Publisher description: DOOH publisher name imp: type: integer title: Imp description: Total impressions type: object required: - campaign_id - campaign_name - publisher - imp title: DoohPublisherCampaignResponseModel DoohPublisherCampaignSortByFieldName: oneOf: - const: imp title: IMP - const: publisher title: PUBLISHER type: string enum: - imp - publisher title: DoohPublisherCampaignSortByFieldName x-enum-varnames: - IMP - PUBLISHER DoohVenueTypeCampaignModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name venue_type: anyOf: - type: string - type: 'null' title: Venue Type description: DOOH venue details adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID, present when all_adgroups or all_creatives adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name, present when all_adgroups or all_creatives creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID, present when all_creatives creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name, present when all_creatives imp: type: integer title: Imp description: Total impressions type: object required: - campaign_id - campaign_name - venue_type - imp title: DoohVenueTypeCampaignModel DoohVenueTypeCampaignSortByFieldName: oneOf: - const: imp title: IMP type: string enum: - imp title: DoohVenueTypeCampaignSortByFieldName x-enum-varnames: - IMP DowMetricsAdgroupModel: properties: dow: type: string title: Dow description: Day of week label account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID when all_creatives=true creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name when all_creatives=true visits: type: number title: Visits description: Store visits for this day-of-week bucket impressions: type: number title: Impressions description: Impressions for this day-of-week bucket clicks: type: number title: Clicks description: Clicks for this day-of-week bucket spend: type: number title: Spend description: Spend (gross revenue) for this day-of-week bucket ctr: type: number title: Ctr description: Click-through rate (percentage) type: object required: - dow - account_name - campaign_id - campaign_name - adgroup_id - adgroup_name - visits - impressions - clicks - spend - ctr title: DowMetricsAdgroupModel description: Day-of-week metrics for an ad group (optionally split by creative). DowMetricsCampaignModel: properties: dow: type: string title: Dow description: Day of week label from the metric timestamp account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID when all_adgroups=true adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name when all_adgroups=true creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID, always null for campaign day-of-week metrics creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name, always null for campaign day-of-week metrics visits: type: number title: Visits description: Store visits for this day-of-week bucket impressions: type: number title: Impressions description: Impressions for this day-of-week bucket clicks: type: number title: Clicks description: Clicks for this day-of-week bucket spend: type: number title: Spend description: Spend (gross revenue) for this day-of-week bucket ctr: type: number title: Ctr description: Click-through rate (percentage) type: object required: - dow - account_name - campaign_id - campaign_name - visits - impressions - clicks - spend - ctr title: DowMetricsCampaignModel description: Day-of-week metrics for a campaign, optionally split by ad group. DowMetricsCreativeModel: properties: dow: type: string title: Dow description: Day of week label from the metric timestamp account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name creative_id: type: integer title: Creative Id description: Creative ID creative_name: type: string title: Creative Name description: Creative name visits: type: number title: Visits description: Store visits for this day-of-week bucket impressions: type: number title: Impressions description: Impressions for this day-of-week bucket clicks: type: number title: Clicks description: Clicks for this day-of-week bucket spend: type: number title: Spend description: Spend (gross revenue) for this day-of-week bucket ctr: type: number title: Ctr description: Click-through rate (percentage) type: object required: - dow - account_name - campaign_id - campaign_name - adgroup_id - adgroup_name - creative_id - creative_name - visits - impressions - clicks - spend - ctr title: DowMetricsCreativeModel description: Day-of-week metrics for a creative. DowTodDataType: oneOf: - const: chart title: CHART - const: full title: FULL type: string enum: - chart - full title: DowTodDataType x-enum-varnames: - CHART - FULL DriveToLocationModel: properties: id: type: string title: Id name: type: string title: Name type: $ref: '#/components/schemas/DriveToLocationType' sensitivity: anyOf: - $ref: '#/components/schemas/Sensitivity' - type: 'null' location_group_metadata: anyOf: - $ref: '#/components/schemas/app__api__models__LocationGroupMetadata' - type: 'null' type: object required: - id - name - type title: DriveToLocationModel DriveToLocationType: oneOf: - const: brand title: BRAND - const: location_group title: LOCATION_GROUP type: string enum: - brand - location_group title: DriveToLocationType x-enum-varnames: - BRAND - LOCATION_GROUP DriveToLocationsSearchResult: properties: type: $ref: '#/components/schemas/DriveToLocationType' id: type: string title: Id name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description sensitivity: anyOf: - $ref: '#/components/schemas/Sensitivity' - type: 'null' description: This only applies to brands location_group_metadata: anyOf: - $ref: '#/components/schemas/app__api__models__LocationGroupMetadata' - type: 'null' type: object required: - type - id - name title: DriveToLocationsSearchResult ErrorModel: properties: code: type: string title: Code message: type: string title: Message fields: anyOf: - items: type: string type: array - type: 'null' title: Fields type: object required: - code - message - fields title: ErrorModel ErrorResponseModel: properties: errors: items: $ref: '#/components/schemas/ErrorModel' type: array title: Errors type: object required: - errors title: ErrorResponseModel ExchangeBidType: oneOf: - const: cpm title: CPM - const: cpc title: CPC type: string enum: - cpm - cpc title: ExchangeBidType x-enum-varnames: - CPM - CPC ExportCampaignsDashboardRequestModel: properties: sort_by: $ref: '#/components/schemas/CampaignDashboardSortField' default: name sort_order: $ref: '#/components/schemas/SortOrder' default: asc start_date: anyOf: - type: string format: date - type: 'null' title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date statuses: anyOf: - items: $ref: '#/components/schemas/CampaignDashboardStatus' type: array - type: 'null' title: Statuses account_ids: anyOf: - items: type: integer type: array - type: 'null' title: Account Ids organization_ids: anyOf: - items: type: integer type: array - type: 'null' title: Organization Ids objectives: anyOf: - items: $ref: '#/components/schemas/Objective' type: array - type: 'null' title: Objectives search: anyOf: - type: string - type: 'null' title: Search columns: anyOf: - items: $ref: '#/components/schemas/CampaignsDashboardExportColumn' type: array - type: 'null' title: Columns included_campaign_ids: anyOf: - items: type: integer type: array - type: 'null' title: Included Campaign Ids excluded_campaign_ids: anyOf: - items: type: integer type: array - type: 'null' title: Excluded Campaign Ids type: object title: ExportCampaignsDashboardRequestModel FootTrafficAttributionDefaultFields: oneOf: - const: account_id title: ACCOUNT_ID - const: order_id title: ORDER_ID - const: media_type title: MEDIA_TYPE - const: bundle_id title: BUNDLE_ID - const: poi_id title: POI_ID - const: visit_date title: VISIT_DATE - const: data_type title: DATA_TYPE type: string enum: - account_id - order_id - media_type - bundle_id - poi_id - visit_date - data_type title: FootTrafficAttributionDefaultFields x-enum-varnames: - ACCOUNT_ID - ORDER_ID - MEDIA_TYPE - BUNDLE_ID - POI_ID - VISIT_DATE - DATA_TYPE FootTrafficAttributionDetailedFilterModel: properties: field: type: string title: Field operator: type: string enum: - '=' - '!=' - '>' - < - '>=' - <= title: Operator value: type: string title: Value type: object required: - field - operator - value title: FootTrafficAttributionDetailedFilterModel FootTrafficAttributionDetailedModel: properties: exposure_key: anyOf: - type: string - type: 'null' title: Exposure Key description: Associated exposure key data_type: anyOf: - type: string - type: 'null' title: Data Type description: Type of media delivery channel - e.g. display, broadcast poi_id: anyOf: - type: string - type: 'null' title: Poi Id description: POI ID associated with the store visit visit_date: type: string format: date title: Visit Date description: Date of the store visit visits: anyOf: - type: integer - type: 'null' title: Visits description: Number of store visits visitors: anyOf: - type: integer - type: 'null' title: Visitors description: Number of store visitors lifetime_visits: anyOf: - type: integer - type: 'null' title: Lifetime Visits description: Cumulative number of visits to the POI by all users up to the given date lifetime_visitors: anyOf: - type: integer - type: 'null' title: Lifetime Visitors description: Cumulative count of unique visitors (distinct user IDs) to the POI up to the given date projected_visits: anyOf: - type: integer - type: 'null' title: Projected Visits description: Total projected visits for the order (or order+POI when with_poi_id is set). This value repeats identically on every row for the same order — do not sum across rows. additionalProperties: true type: object required: - visit_date title: FootTrafficAttributionDetailedModel FootTrafficAttributionDetailedRequestModel: properties: aggregation_level: type: string title: Aggregation Level description: Level of aggregation for the attribution report default: account filters: items: $ref: '#/components/schemas/FootTrafficAttributionDetailedFilterModel' type: array title: Filters start_date: anyOf: - type: string format: date - type: 'null' title: Start Date description: Date should be in YYYY-MM-DD end_date: anyOf: - type: string format: date - type: 'null' title: End Date description: Date should be in YYYY-MM-DD with_poi_id: type: boolean title: With Poi Id description: Include report with POIs default: true page: type: integer minimum: 1.0 title: Page description: Page number (1-based) default: 1 page_size: type: integer maximum: 1000.0 minimum: 1.0 title: Page Size description: Number of items per page (max 1000) default: 100 type: object required: - filters title: FootTrafficAttributionDetailedRequestModel FootTrafficAttributionFieldName: oneOf: - const: visits title: VISITS - const: visitors title: VISITORS - const: lifetime_visits title: LIFETIME_VISITS - const: lifetime_visitors title: LIFETIME_VISITORS type: string enum: - visits - visitors - lifetime_visits - lifetime_visitors title: FootTrafficAttributionFieldName x-enum-varnames: - VISITS - VISITORS - LIFETIME_VISITS - LIFETIME_VISITORS FootTrafficAttributionFilterModel: properties: field: $ref: '#/components/schemas/FootTrafficAttributionDefaultFields' operator: type: string enum: - '=' - '!=' - '>' - < - '>=' - <= title: Operator value: type: string title: Value type: object required: - field - operator - value title: FootTrafficAttributionFilterModel FootTrafficAttributionGroupByFieldName: oneOf: - const: account_id title: ACCOUNT_ID - const: order_id title: ORDER_ID - const: media_type title: MEDIA_TYPE - const: bundle_id title: BUNDLE_ID type: string enum: - account_id - order_id - media_type - bundle_id title: FootTrafficAttributionGroupByFieldName x-enum-varnames: - ACCOUNT_ID - ORDER_ID - MEDIA_TYPE - BUNDLE_ID FootTrafficAttributionModel: properties: order_id: anyOf: - type: string - type: 'null' title: Order Id description: This is the unique identifier which refers to a campaign. account_id: anyOf: - type: string - type: 'null' title: Account Id description: Account ID associated with the store visit bundle_id: anyOf: - type: string - type: 'null' title: Bundle Id description: Bundle ID associated with the store visit media_type: anyOf: - type: string - type: 'null' title: Media Type description: Type of media through which the ad was served data_type: anyOf: - type: string - type: 'null' title: Data Type description: Type of media delivery channel - e.g. display, broadcast poi_id: anyOf: - type: string - type: 'null' title: Poi Id description: POI ID associated with the store visit visit_date: type: string format: date title: Visit Date description: Date of the store visit visits: anyOf: - type: integer - type: 'null' title: Visits description: Number of store visits visitors: anyOf: - type: integer - type: 'null' title: Visitors description: Number of store visitors lifetime_visits: anyOf: - type: integer - type: 'null' title: Lifetime Visits description: Cumulative number of visits to the POI by all users up to the given date lifetime_visitors: anyOf: - type: integer - type: 'null' title: Lifetime Visitors description: Cumulative count of unique visitors (distinct user IDs) to the POI up to the given date projected_visits: anyOf: - type: integer - type: 'null' title: Projected Visits description: Total projected visits for the order (or order+POI when with_poi_id is set). This value repeats identically on every row for the same order — do not sum across rows. type: object required: - visit_date title: FootTrafficAttributionModel FootTrafficAttributionRequestModel: properties: fields: items: $ref: '#/components/schemas/FootTrafficAttributionFieldName' type: array title: Fields aggregation_level: $ref: '#/components/schemas/FootTrafficAttributionGroupByFieldName' description: Level of aggregation for the attribution report default: account_id filters: items: $ref: '#/components/schemas/FootTrafficAttributionFilterModel' type: array title: Filters start_date: anyOf: - type: string format: date - type: 'null' title: Start Date description: Date should be in YYYY-MM-DD end_date: anyOf: - type: string format: date - type: 'null' title: End Date description: Date should be in YYYY-MM-DD with_poi_id: type: boolean title: With Poi Id description: Include report with POIs default: true page: type: integer minimum: 1.0 title: Page description: Page number (1-based) default: 1 page_size: type: integer maximum: 1000.0 minimum: 1.0 title: Page Size description: Number of items per page (max 1000) default: 100 type: object required: - fields - filters title: FootTrafficAttributionRequestModel FootTrafficAttributionV2DetailedModel: properties: order_id: type: string title: Order Id description: This is the unique identifier which refers to a campaign. order_label: type: string title: Order Label description: This represents the label associated with an order. default: '' street_address: type: string title: Street Address description: This represents the street address of a POl. city: type: string title: City description: This represents the city of a POl. state: type: string title: State description: This represents the state of a POl. zip_code: type: integer title: Zip Code description: This represents the ZIP code of a POl. source: type: string title: Source description: This represents the Demand Side Platform (DSP) source. creative_name: type: string title: Creative Name description: Creative name associated with the attribution row. default: '' visit_date: type: string format: date title: Visit Date description: This represents the date of a store visit. campaign_total_impressions: anyOf: - type: integer - type: 'null' title: Campaign Total Impressions description: This represents the daily count of total impressions for each order. campaign_identifiable_impressions: anyOf: - type: integer - type: 'null' title: Campaign Identifiable Impressions description: This represents the total count of impressions that matched within the GT universe at order level. true_visits: anyOf: - type: integer - type: 'null' title: True Visits description: This represents the total count of visits present in GT universe for a POl at a particular flight date. observed_attributed_visits: anyOf: - type: integer - type: 'null' title: Observed Attributed Visits description: This represents the count of visits that were made by the devices at the respective POls per order. cumulative_visits: anyOf: - type: integer - type: 'null' title: Cumulative Visits description: This represents the rolling sum total of attributed visits for an order. type: object required: - order_id - street_address - city - state - zip_code - source - visit_date title: FootTrafficAttributionV2DetailedModel FootTrafficAttributionV2OrderSummaryModel: properties: order_id: type: string title: Order Id description: This is the unique identifier which refers to a campaign. order_label: type: string title: Order Label description: This represents the label associated with an order. default: '' creative_name: type: string title: Creative Name description: Creative name associated with the attribution summary row. default: '' total_impressions: type: integer title: Total Impressions description: This represents the daily count of total impressions for each order. default: 0 identifiable_impressions: type: integer title: Identifiable Impressions description: This represents the total count of impressions that matched within the GT universe at order level. default: 0 observed_attributed_visits: type: integer title: Observed Attributed Visits description: This represents the count of visits that were made by the devices at the respective POls per order. default: 0 vr: type: number title: Vr description: This is the ratio of visit to attributable impressions for each order. default: 0.0 total_locations: type: integer title: Total Locations description: This represents the total number of locations measured across the whole order. default: 0 30_day_lift: type: integer title: 30 Day Lift description: This represents incrementality of visits driven by this order based on the 30-day period prior to order start date. default: 0 60_day_lift: type: integer title: 60 Day Lift description: This represents incrementality of visits driven by this order based on the 60-day period prior to order start date. default: 0 90_day_lift: type: integer title: 90 Day Lift description: This represents incrementality of visits driven by this order based on the 90-day period prior to order start date. default: 0 average_raw_visits: type: integer title: Average Raw Visits description: This represents the average number of visits to a POI for an order. default: 0 projected_visits: type: integer title: Projected Visits description: This represents the projected number of visits to a POI for an order. default: 0 loyalists: type: integer title: Loyalists description: This represents the visitors seen within the last 30 days. default: 0 non_loyalists: type: integer title: Non Loyalists description: This represents the visitors not seen in the last 90 days. default: 0 type: object required: - order_id title: FootTrafficAttributionV2OrderSummaryModel FpPoitagAdgroupResponseModel: properties: account_name: anyOf: - type: string - type: 'null' title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID (always null for this report) creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name (always null for this report) poitag_id: anyOf: - type: string - type: 'null' title: Poitag Id description: First-party POI tag identifier poitag_name: anyOf: - type: string - type: 'null' title: Poitag Name description: Resolved POI tag display name from tags dimension impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Spend (xad gross revenue) ctr: type: number title: Ctr description: Click-through rate (percent) cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Click-to-call actions directions: type: number title: Directions description: Directions actions website: type: number title: Website description: Website actions moreinfo: type: number title: Moreinfo description: More info actions coupon: type: number title: Coupon description: Coupon actions video: type: number title: Video description: Video (media) actions visits: type: number title: Visits description: Ad group visits (site visitation type 2) cumulative_reach: anyOf: - type: number - type: 'null' title: Cumulative Reach description: Cumulative reach for the POI tag / row (null when reach data is missing) type: object required: - campaign_id - campaign_name - adgroup_id - adgroup_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video - visits title: FpPoitagAdgroupResponseModel description: First-party POI tag cumulative metrics for an ad group. FpPoitagCampaignResponseModel: properties: account_name: anyOf: - type: string - type: 'null' title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID when all_adgroups is true adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name when all_adgroups is true creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID (always null for this report) creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name (always null for this report) poitag_id: anyOf: - type: string - type: 'null' title: Poitag Id description: First-party POI tag identifier poitag_name: anyOf: - type: string - type: 'null' title: Poitag Name description: Resolved POI tag display name from tags dimension impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Spend (xad gross revenue) ctr: type: number title: Ctr description: Click-through rate (percent) cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Click-to-call actions directions: type: number title: Directions description: Directions actions website: type: number title: Website description: Website actions moreinfo: type: number title: Moreinfo description: More info actions coupon: type: number title: Coupon description: Coupon actions video: type: number title: Video description: Video (media) actions visits: type: number title: Visits description: Total visits (site visitation type 1) sum_of_adgroup_visits: type: number title: Sum Of Adgroup Visits description: Sum of ad group visitation (site visitation type 2) cumulative_reach: anyOf: - type: number - type: 'null' title: Cumulative Reach description: Cumulative reach for the POI tag / row (null when reach data is missing) type: object required: - campaign_id - campaign_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video - visits - sum_of_adgroup_visits title: FpPoitagCampaignResponseModel description: First-party POI tag cumulative metrics for a campaign, optionally split by ad group. GTLandingPagePageOverlayAction: oneOf: - const: website title: WEBSITE - const: moreinfo title: MORE_INFO - const: appstore title: APP_STORE - const: passbook title: PASSBOOK - const: direction title: DIRECTION - const: coupon title: COUPON - const: media title: MEDIA type: string enum: - website - moreinfo - appstore - passbook - direction - coupon - media title: GTLandingPagePageOverlayAction x-enum-varnames: - WEBSITE - MORE_INFO - APP_STORE - PASSBOOK - DIRECTION - COUPON - MEDIA Gender: oneOf: - const: M title: MALE - const: F title: FEMALE - const: unknown title: UNKNOWN type: string enum: - M - F - unknown title: Gender x-enum-varnames: - MALE - FEMALE - UNKNOWN GetDailyMetricsAdgroupResponseModel: properties: daily_metrics: items: $ref: '#/components/schemas/DailyMetricsAdgroupModel' type: array title: Daily Metrics adgroup_today_spend: anyOf: - type: number - type: 'null' title: Adgroup Today Spend date: anyOf: - type: string format: date - type: 'null' title: Date description: Current date in the ad group's timezone type: object required: - daily_metrics title: GetDailyMetricsAdgroupResponseModel GetDailyMetricsCampaignResponseModel: properties: daily_metrics: items: $ref: '#/components/schemas/DailyMetricsCampaignModel' type: array title: Daily Metrics campaign_today_spend: anyOf: - type: number - type: 'null' title: Campaign Today Spend date: anyOf: - type: string format: date - type: 'null' title: Date description: Current date in the campaign's timezone type: object required: - daily_metrics title: GetDailyMetricsCampaignResponseModel GetDailyMetricsCreativeResponseModel: properties: daily_metrics: items: $ref: '#/components/schemas/DailyMetricsCreativeModel' type: array title: Daily Metrics type: object required: - daily_metrics title: GetDailyMetricsCreativeResponseModel Group: oneOf: - const: 1 title: ADMIN - const: 2 title: DIRECT_SALES - const: 3 title: CHANNEL_SALES - const: 4 title: DIRECT_OPS - const: 5 title: CHANNEL_OPS - const: 6 title: SUPPLY_OPS - const: 7 title: MONETIZATION - const: 8 title: EXECUTIVES - const: 9 title: EXPERIMENTAL - const: 10 title: SELF_SERVICE_ADMIN - const: 11 title: ENGINEERING - const: 12 title: ACCOUNT_MANAGER - const: 15 title: MARKETING - const: 16 title: CLIENT_PUBLISHER - const: 18 title: PRODUCT - const: 20 title: BLUEPRINTER - const: 21 title: BLUEPRINTS_CONTRACTUAL_AUDITOR - const: 25 title: BLUEPRINTS_ADMIN - const: 26 title: BLUEPRINTS_DQ_USER - const: 27 title: BLUEPRINTS_INGESTION_USER - const: 28 title: BLUEPRINTS_OO_USER - const: 29 title: BLUEPRINTS_PQ_USER - const: 30 title: BLUEPRINTS_AUDITOR - const: 31 title: BETA - const: 41 title: CREATIVE_EDITOR - const: 42 title: CHANNEL_PARTNER - const: 43 title: SELF_SERVICE - const: 44 title: HOLDING_COMPANY - const: 45 title: VIEW_ONLY - const: 46 title: CPV - const: 47 title: VISIT_OPTIMIZATION - const: 48 title: CROSS_DEVICE - const: 49 title: REPORTING_ONLY - const: 55 title: ANALYST - const: 56 title: PALPATINE_MANAGEMENT - const: 59 title: BLUEPRINTS_QA_TRAINEE - const: 60 title: BLUEPRINTS_EDITOR_TRAINEE - const: 63 title: BLUEPRINTS_HQ_USER type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 15 - 16 - 18 - 20 - 21 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 55 - 56 - 59 - 60 - 63 title: Group x-enum-varnames: - ADMIN - DIRECT_SALES - CHANNEL_SALES - DIRECT_OPS - CHANNEL_OPS - SUPPLY_OPS - MONETIZATION - EXECUTIVES - EXPERIMENTAL - SELF_SERVICE_ADMIN - ENGINEERING - ACCOUNT_MANAGER - MARKETING - CLIENT_PUBLISHER - PRODUCT - BLUEPRINTER - BLUEPRINTS_CONTRACTUAL_AUDITOR - BLUEPRINTS_ADMIN - BLUEPRINTS_DQ_USER - BLUEPRINTS_INGESTION_USER - BLUEPRINTS_OO_USER - BLUEPRINTS_PQ_USER - BLUEPRINTS_AUDITOR - BETA - CREATIVE_EDITOR - CHANNEL_PARTNER - SELF_SERVICE - HOLDING_COMPANY - VIEW_ONLY - CPV - VISIT_OPTIMIZATION - CROSS_DEVICE - REPORTING_ONLY - ANALYST - PALPATINE_MANAGEMENT - BLUEPRINTS_QA_TRAINEE - BLUEPRINTS_EDITOR_TRAINEE - BLUEPRINTS_HQ_USER HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError IABCategoriesResponseModel: properties: items: items: $ref: '#/components/schemas/IABCategoryModel' type: array title: Items type: object required: - items title: IABCategoriesResponseModel IABCategoryModel: properties: id: type: integer title: Id category: type: string title: Category name: type: string title: Name children: anyOf: - items: $ref: '#/components/schemas/IABCategoryModel' type: array - type: 'null' title: Children type: object required: - id - category - name title: IABCategoryModel ImageLandingPage-Input: properties: type: type: integer const: 3 title: Type background_image_url: type: string maxLength: 2083 minLength: 1 format: uri title: Background Image Url description: Must be 640x960 or proportional directions_overlay_css: anyOf: - type: string - type: 'null' title: Directions Overlay Css call_overlay_css: anyOf: - type: string - type: 'null' title: Call Overlay Css text_1_overlay: anyOf: - type: string - type: 'null' title: Text 1 Overlay text_1_overlay_css: anyOf: - type: string - type: 'null' title: Text 1 Overlay Css text_2_overlay: anyOf: - type: string - type: 'null' title: Text 2 Overlay text_2_overlay_css: anyOf: - type: string - type: 'null' title: Text 2 Overlay Css additional_overlay_1_action: anyOf: - $ref: '#/components/schemas/GTLandingPagePageOverlayAction' - type: 'null' additional_overlay_1_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Additional Overlay 1 Url additional_overlay_1_css: anyOf: - type: string - type: 'null' title: Additional Overlay 1 Css additional_overlay_2_action: anyOf: - $ref: '#/components/schemas/GTLandingPagePageOverlayAction' - type: 'null' additional_overlay_2_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Additional Overlay 2 Url additional_overlay_2_css: anyOf: - type: string - type: 'null' title: Additional Overlay 2 Css additional_overlay_3_action: anyOf: - $ref: '#/components/schemas/GTLandingPagePageOverlayAction' - type: 'null' additional_overlay_3_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Additional Overlay 3 Url additional_overlay_3_css: anyOf: - type: string - type: 'null' title: Additional Overlay 3 Css additional_overlay_4_action: anyOf: - $ref: '#/components/schemas/GTLandingPagePageOverlayAction' - type: 'null' additional_overlay_4_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Additional Overlay 4 Url additional_overlay_4_css: anyOf: - type: string - type: 'null' title: Additional Overlay 4 Css youtube_video_id: anyOf: - type: string - type: 'null' title: Youtube Video Id description: The `v` query parameter from a Youtube video URL youtube_video_css: anyOf: - type: string - type: 'null' title: Youtube Video Css type: object required: - type - background_image_url title: ImageLandingPage ImageLandingPage-Output: properties: type: type: integer const: 3 title: Type background_image_url: type: string title: Background Image Url description: Must be 640x960 or proportional directions_overlay_css: anyOf: - type: string - type: 'null' title: Directions Overlay Css call_overlay_css: anyOf: - type: string - type: 'null' title: Call Overlay Css text_1_overlay: anyOf: - type: string - type: 'null' title: Text 1 Overlay text_1_overlay_css: anyOf: - type: string - type: 'null' title: Text 1 Overlay Css text_2_overlay: anyOf: - type: string - type: 'null' title: Text 2 Overlay text_2_overlay_css: anyOf: - type: string - type: 'null' title: Text 2 Overlay Css additional_overlay_1_action: anyOf: - $ref: '#/components/schemas/GTLandingPagePageOverlayAction' - type: 'null' additional_overlay_1_url: anyOf: - type: string - type: 'null' title: Additional Overlay 1 Url additional_overlay_1_css: anyOf: - type: string - type: 'null' title: Additional Overlay 1 Css additional_overlay_2_action: anyOf: - $ref: '#/components/schemas/GTLandingPagePageOverlayAction' - type: 'null' additional_overlay_2_url: anyOf: - type: string - type: 'null' title: Additional Overlay 2 Url additional_overlay_2_css: anyOf: - type: string - type: 'null' title: Additional Overlay 2 Css additional_overlay_3_action: anyOf: - $ref: '#/components/schemas/GTLandingPagePageOverlayAction' - type: 'null' additional_overlay_3_url: anyOf: - type: string - type: 'null' title: Additional Overlay 3 Url additional_overlay_3_css: anyOf: - type: string - type: 'null' title: Additional Overlay 3 Css additional_overlay_4_action: anyOf: - $ref: '#/components/schemas/GTLandingPagePageOverlayAction' - type: 'null' additional_overlay_4_url: anyOf: - type: string - type: 'null' title: Additional Overlay 4 Url additional_overlay_4_css: anyOf: - type: string - type: 'null' title: Additional Overlay 4 Css youtube_video_id: anyOf: - type: string - type: 'null' title: Youtube Video Id description: The `v` query parameter from a Youtube video URL youtube_video_css: anyOf: - type: string - type: 'null' title: Youtube Video Css type: object required: - type - background_image_url title: ImageLandingPage ImpMembershipBreakdownAdgroupModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name key: $ref: '#/components/schemas/ImpMembershipBreakdownKey' description: 'Membership dimension: brand, category, or behaviour.' total_impressed_users: items: type: string type: array title: Total Impressed Users description: Array of "label count" strings for impressed users per segment percent_impressed_users: items: type: string type: array title: Percent Impressed Users description: Array of "label percent" strings for share of impressed users per segment type: object required: - account_name - campaign_id - campaign_name - adgroup_id - adgroup_name - key - total_impressed_users - percent_impressed_users title: ImpMembershipBreakdownAdgroupModel description: Response model for ad group-level impression membership breakdown (user insight). ImpMembershipBreakdownCampaignModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name key: type: integer title: Key description: 'Membership type: 1=brand, 2=category, 3=behaviour' total_impressed_users: items: type: string type: array title: Total Impressed Users description: Array of "label count" strings for impressed users per segment percent_impressed_users: items: type: string type: array title: Percent Impressed Users description: Array of "label percent" strings for share of impressed users per segment type: object required: - account_name - campaign_id - campaign_name - key - total_impressed_users - percent_impressed_users title: ImpMembershipBreakdownCampaignModel description: Response model for campaign-level impression membership breakdown (user insight). ImpMembershipBreakdownKey: oneOf: - const: 1 title: BRAND description: 'Membership type for impression membership breakdown (user insight): brand, category, or behaviour.' - const: 2 title: CATEGORY description: 'Membership type for impression membership breakdown (user insight): brand, category, or behaviour.' - const: 3 title: BEHAVIOUR description: 'Membership type for impression membership breakdown (user insight): brand, category, or behaviour.' type: integer enum: - 1 - 2 - 3 title: ImpMembershipBreakdownKey description: 'Membership type for impression membership breakdown (user insight): brand, category, or behaviour.' x-enum-varnames: - BRAND - CATEGORY - BEHAVIOUR IncomeRange: oneOf: - const: '-50' title: _50_UNDER - const: 50-100 title: _50_100 - const: 100-150 title: _100_150 - const: 150-200 title: _150_200 - const: 200- title: _200_UP type: string enum: - '-50' - 50-100 - 100-150 - 150-200 - 200- title: IncomeRange x-enum-varnames: - _50_UNDER - _50_100 - _100_150 - _150_200 - _200_UP IncrementalVisitsAdgroupModel: properties: adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name visit_freq_type: type: integer title: Visit Freq Type description: Visit frequency bucket (user_bucket) imp: type: number title: Imp description: Impressions vst: type: number title: Vst description: Visits oh_vst: type: number title: Oh Vst description: Open hour visits clks: type: number title: Clks description: Clicks ctr: type: number title: Ctr description: Click-through rate sp: type: number title: Sp description: Spend sa: type: number title: Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Click-to-call actions directions: type: number title: Directions description: Directions actions website: type: number title: Website description: Website actions moreinfo: type: number title: Moreinfo description: More info actions coupon: type: number title: Coupon description: Coupon actions vr: type: number title: Vr description: Visit rate (visits / impressions) type: object required: - adgroup_id - adgroup_name - visit_freq_type - imp - vst - oh_vst - clks - ctr - sp - sa - sar - click_to_call - directions - website - moreinfo - coupon - vr title: IncrementalVisitsAdgroupModel description: Incremental visits by ad group at ad group level (visit frequency bucket). IncrementalVisitsCampaignAdgroupModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name visit_freq_type: type: integer title: Visit Freq Type description: Visit frequency bucket (user_bucket) imp: type: number title: Imp description: Impressions vst: type: number title: Vst description: Visits oh_vst: type: number title: Oh Vst description: Open hour visits clks: type: number title: Clks description: Clicks ctr: type: number title: Ctr description: Click-through rate sp: type: number title: Sp description: Spend sa: type: number title: Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Click-to-call actions directions: type: number title: Directions description: Directions actions website: type: number title: Website description: Website actions moreinfo: type: number title: Moreinfo description: More info actions coupon: type: number title: Coupon description: Coupon actions vr: type: number title: Vr description: Visit rate (visits / impressions) type: object required: - campaign_id - campaign_name - adgroup_id - adgroup_name - visit_freq_type - imp - vst - oh_vst - clks - ctr - sp - sa - sar - click_to_call - directions - website - moreinfo - coupon - vr title: IncrementalVisitsCampaignAdgroupModel description: Incremental visits by visit frequency bucket for each ad group under a campaign. IncrementalVisitsCampaignModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name visit_freq_type: type: integer title: Visit Freq Type description: Visit frequency bucket (user_bucket) imp: type: number title: Imp description: Impressions vst: type: number title: Vst description: Visits oh_vst: type: number title: Oh Vst description: Open hour visits clks: type: number title: Clks description: Clicks ctr: type: number title: Ctr description: Click-through rate sp: type: number title: Sp description: Spend sa: type: number title: Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Click-to-call actions directions: type: number title: Directions description: Directions actions website: type: number title: Website description: Website actions moreinfo: type: number title: Moreinfo description: More info actions coupon: type: number title: Coupon description: Coupon actions vr: type: number title: Vr description: Visit rate (visits / impressions) type: object required: - campaign_id - campaign_name - visit_freq_type - imp - vst - oh_vst - clks - ctr - sp - sa - sar - click_to_call - directions - website - moreinfo - coupon - vr title: IncrementalVisitsCampaignModel description: Incremental visits by campaign at campaign level (visit frequency bucket). IncrementalVisitsCreativeModel: properties: creative_id: type: integer title: Creative Id description: Creative ID creative_name: type: string title: Creative Name description: Creative name visit_freq_type: type: integer title: Visit Freq Type description: Visit frequency bucket (user_bucket) imp: type: number title: Imp description: Impressions vst: type: number title: Vst description: Visits oh_vst: type: number title: Oh Vst description: Open hour visits clks: type: number title: Clks description: Clicks ctr: type: number title: Ctr description: Click-through rate sp: type: number title: Sp description: Spend sa: type: number title: Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Click-to-call actions directions: type: number title: Directions description: Directions actions website: type: number title: Website description: Website actions moreinfo: type: number title: Moreinfo description: More info actions coupon: type: number title: Coupon description: Coupon actions vr: type: number title: Vr description: Visit rate (visits / impressions) type: object required: - creative_id - creative_name - visit_freq_type - imp - vst - oh_vst - clks - ctr - sp - sa - sar - click_to_call - directions - website - moreinfo - coupon - vr title: IncrementalVisitsCreativeModel description: Incremental visits by creative at creative level (visit frequency bucket). IntegrationReport: oneOf: - const: USAMP title: USAMP - const: PLACED title: PLACED_FOURSQUARE - const: LIVERAMP title: LIVE_RAMP_EXPOSURE_FILES - const: XAD title: XAD_EXPOSURE_FILE - const: NEUSTAR title: NEUSTAR - const: CARDLYTICS title: CARDLYTICS - const: AFFINITY title: AFFINITY type: string enum: - USAMP - PLACED - LIVERAMP - XAD - NEUSTAR - CARDLYTICS - AFFINITY title: IntegrationReport x-enum-varnames: - USAMP - PLACED_FOURSQUARE - LIVE_RAMP_EXPOSURE_FILES - XAD_EXPOSURE_FILE - NEUSTAR - CARDLYTICS - AFFINITY JobModel: properties: job_id: type: integer title: Job Id type: $ref: '#/components/schemas/UploadJobType' status: $ref: '#/components/schemas/JobStatus' message: anyOf: - type: string - type: 'null' title: Message input_file_url: anyOf: - type: string - type: 'null' title: Input File Url description: Instead of a URL, this can sometimes be a path output_file_url: anyOf: - type: string - type: 'null' title: Output File Url description: Instead of a URL, this can sometimes be a path progress: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Progress account_id: anyOf: - type: integer - type: 'null' title: Account Id campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id creative_id: anyOf: - type: integer - type: 'null' title: Creative Id type: object required: - job_id - type - status - message - input_file_url - output_file_url - account_id - campaign_id - adgroup_id - creative_id title: JobModel JobStatus: oneOf: - const: 0 title: NEW - const: 1 title: IN_PROGRESS - const: 2 title: SUCCESSFULLY_DONE - const: 3 title: FAILED_DONE - const: 4 title: CANCELLED - const: 5 title: CONFIRMED - const: 6 title: EXPIRED type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 title: JobStatus x-enum-varnames: - NEW - IN_PROGRESS - SUCCESSFULLY_DONE - FAILED_DONE - CANCELLED - CONFIRMED - EXPIRED JobsModel: properties: items: items: $ref: '#/components/schemas/JobModel' type: array title: Items type: object required: - items title: JobsModel Language: oneOf: - const: en title: ENGLISH - const: es title: SPANISH type: string enum: - en - es title: Language x-enum-varnames: - ENGLISH - SPANISH LocationFilterModel-Input: properties: type: $ref: '#/components/schemas/LocationFilterType' exclude: type: boolean title: Exclude default: false city: anyOf: - type: string - type: 'null' title: City state: anyOf: - type: string - type: 'null' title: State description: State code zip_code: anyOf: - type: string - type: 'null' title: Zip Code county: anyOf: - type: string - type: 'null' title: County description: County name dma: anyOf: - type: string - type: 'null' title: Dma description: DMA name lat: anyOf: - type: number maximum: 90.0 minimum: -90.0 - type: 'null' title: Lat lng: anyOf: - type: number maximum: 180.0 minimum: -180.0 - type: 'null' title: Lng address: anyOf: - type: string - type: 'null' title: Address radius: anyOf: - type: number - type: 'null' title: Radius type: object required: - type title: LocationFilterModel LocationFilterModel-Output: properties: type: $ref: '#/components/schemas/LocationFilterType' exclude: type: boolean title: Exclude default: false city: anyOf: - type: string - type: 'null' title: City state: anyOf: - type: string - type: 'null' title: State description: State code zip_code: anyOf: - type: string - type: 'null' title: Zip Code county: anyOf: - type: string - type: 'null' title: County description: County name dma: anyOf: - type: string - type: 'null' title: Dma description: DMA name lat: anyOf: - type: number maximum: 90.0 minimum: -90.0 - type: 'null' title: Lat lng: anyOf: - type: number maximum: 180.0 minimum: -180.0 - type: 'null' title: Lng address: anyOf: - type: string - type: 'null' title: Address radius: anyOf: - type: number - type: 'null' title: Radius display_name: type: string title: Display Name readOnly: true type: object required: - type - display_name title: LocationFilterModel LocationFilterSearchResultModel: properties: name: type: string title: Name city: anyOf: - type: string - type: 'null' title: City state: anyOf: - type: string - type: 'null' title: State description: State code zip_code: anyOf: - type: string - type: 'null' title: Zip Code county: anyOf: - type: string - type: 'null' title: County dma: anyOf: - type: string - type: 'null' title: Dma description: DMA name lat: anyOf: - type: number maximum: 90.0 minimum: -90.0 - type: 'null' title: Lat lng: anyOf: - type: number maximum: 180.0 minimum: -180.0 - type: 'null' title: Lng address: anyOf: - type: string - type: 'null' title: Address google_place_id: anyOf: - type: string - type: 'null' title: Google Place Id description: Only applies to addresses type: object required: - name title: LocationFilterSearchResultModel LocationFilterType: oneOf: - const: City title: CITY - const: State title: STATE - const: Zip title: ZIP_CODE - const: DMA title: DMA - const: County title: COUNTY - const: LatLng title: LAT_LNG - const: Address title: ADDRESS type: string enum: - City - State - Zip - DMA - County - LatLng - Address title: LocationFilterType x-enum-varnames: - CITY - STATE - ZIP_CODE - DMA - COUNTY - LAT_LNG - ADDRESS LocationFiltersModel: properties: items: items: $ref: '#/components/schemas/LocationFilterModel-Output' type: array title: Items type: object required: - items title: LocationFiltersModel LocationGroupBuildStatus: oneOf: - const: not_required title: NOT_REQUIRED - const: initial title: INITIAL - const: in_progress title: IN_PROGRESS - const: updating title: UPDATING - const: ready title: READY - const: expired title: EXPIRED type: string enum: - not_required - initial - in_progress - updating - ready - expired title: LocationGroupBuildStatus x-enum-varnames: - NOT_REQUIRED - INITIAL - IN_PROGRESS - UPDATING - READY - EXPIRED LocationGroupResult: properties: id: type: string title: Id name: anyOf: - type: string - type: 'null' title: Name description: anyOf: - type: string - type: 'null' title: Description url: anyOf: - type: string - type: 'null' title: Url accepted: anyOf: - type: integer - type: 'null' title: Accepted invalid: anyOf: - type: integer - type: 'null' title: Invalid conflict: anyOf: - type: integer - type: 'null' title: Conflict rejected: anyOf: - type: integer - type: 'null' title: Rejected tag_type: anyOf: - $ref: '#/components/schemas/LocationGroupType' - type: 'null' build_status: $ref: '#/components/schemas/LocationGroupBuildStatus' default: not_required is_sensitive: type: boolean title: Is Sensitive default: false type: object required: - id title: LocationGroupResult LocationGroupType: oneOf: - const: 0 title: BUSINESS - const: 1 title: RESIDENTIAL type: integer enum: - 0 - 1 title: LocationGroupType x-enum-varnames: - BUSINESS - RESIDENTIAL LocationImpressionAdgroupModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name country: anyOf: - type: string - type: 'null' title: Country description: Location country state: anyOf: - type: string - type: 'null' title: State description: Location state city: anyOf: - type: string - type: 'null' title: City description: Location city dma: anyOf: - type: integer - type: 'null' title: Dma description: Location DMA code zip: anyOf: - type: string - type: 'null' title: Zip description: Location zip or postal code address: anyOf: - type: string - type: 'null' title: Address description: Location address latitude: anyOf: - type: number - type: 'null' title: Latitude description: Location latitude longitude: anyOf: - type: number - type: 'null' title: Longitude description: Location longitude location_name: anyOf: - type: string - type: 'null' title: Location Name description: Location name business_name: anyOf: - type: string - type: 'null' title: Business Name description: Business name impressions: type: integer title: Impressions description: Impressions clicks: type: integer title: Clicks description: Clicks total_sa: type: integer title: Total Sa description: Total secondary actions type: object required: - campaign_id - campaign_name - adgroup_id - adgroup_name - impressions - clicks - total_sa title: LocationImpressionAdgroupModel LocationImpressionCampaignModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID, present when all_adgroups is true adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name, present when all_adgroups is true country: anyOf: - type: string - type: 'null' title: Country description: Country code state: anyOf: - type: string - type: 'null' title: State description: State code city: anyOf: - type: string - type: 'null' title: City description: City name dma: anyOf: - type: integer - type: 'null' title: Dma description: DMA code zipcode: anyOf: - type: string - type: 'null' title: Zipcode description: Zip or postal code address: anyOf: - type: string - type: 'null' title: Address description: Location address latitude: anyOf: - type: number - type: 'null' title: Latitude description: Location latitude longitude: anyOf: - type: number - type: 'null' title: Longitude description: Location longitude location_name: anyOf: - type: string - type: 'null' title: Location Name description: Location name business_name: anyOf: - type: string - type: 'null' title: Business Name description: Business name impressions: type: integer title: Impressions description: Total impressions clicks: type: integer title: Clicks description: Total clicks total_sa: type: integer title: Total Sa description: Total secondary actions type: object required: - campaign_id - campaign_name - impressions - clicks - total_sa title: LocationImpressionCampaignModel LocationVisitAdgroupModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name poi_id: type: string title: Poi Id description: POI ID country: anyOf: - type: string - type: 'null' title: Country description: Country code state: anyOf: - type: string - type: 'null' title: State description: State code city: anyOf: - type: string - type: 'null' title: City description: City name dma: anyOf: - type: integer - type: 'null' title: Dma description: DMA code zip: anyOf: - type: string - type: 'null' title: Zip description: Zip or postal code address: anyOf: - type: string - type: 'null' title: Address description: Location address latitude: anyOf: - type: number - type: 'null' title: Latitude description: Location latitude longitude: anyOf: - type: number - type: 'null' title: Longitude description: Location longitude sv: type: number title: Sv description: Store visits type: object required: - campaign_id - campaign_name - adgroup_id - adgroup_name - poi_id - sv title: LocationVisitAdgroupModel LocationVisitCampaignModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID when all_adgroups=true adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name when all_adgroups=true poi_id: type: string title: Poi Id description: Visited POI ID country: anyOf: - type: string - type: 'null' title: Country description: POI country state: anyOf: - type: string - type: 'null' title: State description: POI state city: anyOf: - type: string - type: 'null' title: City description: POI city dma: anyOf: - type: integer - type: 'null' title: Dma description: POI DMA zip: anyOf: - type: string - type: 'null' title: Zip description: POI ZIP code address: anyOf: - type: string - type: 'null' title: Address description: POI address latitude: anyOf: - type: number - type: 'null' title: Latitude description: POI latitude longitude: anyOf: - type: number - type: 'null' title: Longitude description: POI longitude sv: type: number title: Sv description: Total store visits type: object required: - campaign_id - campaign_name - poi_id - sv title: LocationVisitCampaignModel LookalikeAudienceScale: oneOf: - const: 1 title: SCALE_2X - const: 3 title: SCALE_4X - const: 5 title: SCALE_6X - const: 9 title: SCALE_10X type: integer enum: - 1 - 3 - 5 - 9 title: LookalikeAudienceScale x-enum-varnames: - SCALE_2X - SCALE_4X - SCALE_6X - SCALE_10X MarketShareCampaignModel: properties: campaign_id: type: integer title: Campaign Id updated_date: type: string title: Updated Date description: Date of the most recent market share calculation (YYYY-MM-DD) number_of_poi: type: integer title: Number Of Poi description: Number of points of interest (locations) categories_sic: type: string title: Categories Sic description: SIC description of the market share category market_share_status: type: string title: Market Share Status description: Status of the market share calculation type: object required: - campaign_id - updated_date - number_of_poi - categories_sic - market_share_status title: MarketShareCampaignModel MediaType: oneOf: - const: app title: APP - const: web title: MOBILE_WEB - const: desktop title: DESKTOP - const: ott title: OTT - const: ctv title: CTV - const: audio-podcast title: AUDIO_PODCAST - const: audio-streaming title: AUDIO_STREAMING - const: dooh title: DOOH type: string enum: - app - web - desktop - ott - ctv - audio-podcast - audio-streaming - dooh title: MediaType x-enum-varnames: - APP - MOBILE_WEB - DESKTOP - OTT - CTV - AUDIO_PODCAST - AUDIO_STREAMING - DOOH MobileCarrierCode: oneOf: - const: ALLTEL title: ALLTEL - const: APPLCHN title: APPALACHIAN_WIRELESS - const: ATT title: ATT - const: BLUEGRASS title: BLUEGRASS_CELLULAR - const: CINCINNATI title: CINCINNATI_BELL - const: CORR title: CORR_WIRELESS - const: CRICKET title: CRICKET - const: METROPCS title: METRO_PCS - const: PLATEAU title: PLATEAU_WIRELESS - const: SIMMETRY title: SIMMETRY - const: SPRINT title: SPRINT - const: TMOBILE title: TMOBILE - const: USCELLULAR title: US_CELLULAR - const: VERIZON title: VERIZON_WIRELESS - const: WIFI title: WIFI type: string enum: - ALLTEL - APPLCHN - ATT - BLUEGRASS - CINCINNATI - CORR - CRICKET - METROPCS - PLATEAU - SIMMETRY - SPRINT - TMOBILE - USCELLULAR - VERIZON - WIFI title: MobileCarrierCode x-enum-varnames: - ALLTEL - APPALACHIAN_WIRELESS - ATT - BLUEGRASS_CELLULAR - CINCINNATI_BELL - CORR_WIRELESS - CRICKET - METRO_PCS - PLATEAU_WIRELESS - SIMMETRY - SPRINT - TMOBILE - US_CELLULAR - VERIZON_WIRELESS - WIFI MobileCarrierModel: properties: code: type: string title: Code name: type: string title: Name type: object required: - code - name title: MobileCarrierModel MobileCarriersModel: properties: items: items: $ref: '#/components/schemas/MobileCarrierModel' type: array title: Items type: object required: - items title: MobileCarriersModel MobileCategoryAdgroupModel: properties: adgroup_id: type: integer title: Adgroup Id adgroup_name: type: string title: Adgroup Name category: type: string title: Category imp: type: integer title: Imp description: Total impressions ctr: type: number title: Ctr description: Click-through rate type: object required: - adgroup_id - adgroup_name - category - imp - ctr title: MobileCategoryAdgroupModel MobileCategoryCampaignAllAdgroupsModel: properties: campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name adgroup_id: type: integer title: Adgroup Id adgroup_name: type: string title: Adgroup Name category: type: string title: Category imp: type: integer title: Imp description: Total impressions ctr: type: number title: Ctr description: Click-through rate type: object required: - campaign_id - campaign_name - adgroup_id - adgroup_name - category - imp - ctr title: MobileCategoryCampaignAllAdgroupsModel MobileCategoryCampaignModel: properties: campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name category: type: string title: Category imp: type: integer title: Imp description: Total impressions ctr: type: number title: Ctr description: Click-through rate type: object required: - campaign_id - campaign_name - category - imp - ctr title: MobileCategoryCampaignModel MobileCategoryFieldName: oneOf: - const: imp title: IMP - const: ctr title: CTR type: string enum: - imp - ctr title: MobileCategoryFieldName x-enum-varnames: - IMP - CTR MultiPatchCreativeModel: properties: name: anyOf: - type: string maxLength: 128 minLength: 1 - type: 'null' title: Name status: anyOf: - $ref: '#/components/schemas/CreativeStatus' - type: 'null' start_date: anyOf: - type: string format: date - type: 'null' title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date freq_cap_duration: anyOf: - type: integer maximum: 126.0 minimum: 1.0 - type: 'null' title: Freq Cap Duration freq_cap_value: anyOf: - type: integer maximum: 32766.0 minimum: 1.0 - type: 'null' title: Freq Cap Value rotation_weight: anyOf: - type: integer maximum: 32766.0 minimum: 1.0 - type: 'null' title: Rotation Weight click_through_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Click Through Url third_party_placement_id: anyOf: - type: string maxLength: 128 - type: 'null' title: Third Party Placement Id id: type: integer title: Id type: object required: - id title: MultiPatchCreativeModel NeighborhoodModel: properties: id: type: string title: Id name: type: string title: Name type: $ref: '#/components/schemas/NeighborhoodTargetType' sensitivity: anyOf: - $ref: '#/components/schemas/Sensitivity' - type: 'null' location_group_metadata: anyOf: - $ref: '#/components/schemas/app__api__models__LocationGroupMetadata' - type: 'null' type: object required: - id - name - type title: NeighborhoodModel NeighborhoodSearchResult: properties: type: $ref: '#/components/schemas/NeighborhoodTargetType' id: type: string title: Id name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description sensitivity: anyOf: - $ref: '#/components/schemas/Sensitivity' - type: 'null' location_group_metadata: anyOf: - $ref: '#/components/schemas/app__api__models__LocationGroupMetadata' - type: 'null' type: object required: - type - id - name title: NeighborhoodSearchResult NeighborhoodTargetType: oneOf: - const: behavior title: BEHAVIOR - const: brand title: BRAND - const: category title: CATEGORY - const: location_group title: LOCATION_GROUP type: string enum: - behavior - brand - category - location_group title: NeighborhoodTargetType x-enum-varnames: - BEHAVIOR - BRAND - CATEGORY - LOCATION_GROUP NeighborhoodType: oneOf: - const: business title: BUSINESS - const: residential title: RESIDENTIAL type: string enum: - business - residential title: NeighborhoodType x-enum-varnames: - BUSINESS - RESIDENTIAL Objective: oneOf: - const: 1 title: BRAND_AWARENESS - const: 2 title: AD_CLICKS - const: 3 title: IN_STORE_VISITS - const: 4 title: REACH - const: 5 title: VIDEO_VIEWS - const: 6 title: AUDIO_LISTENS type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 title: Objective x-enum-varnames: - BRAND_AWARENESS - AD_CLICKS - IN_STORE_VISITS - REACH - VIDEO_VIEWS - AUDIO_LISTENS OnPremiseLocationModel: properties: id: type: string title: Id name: type: string title: Name type: $ref: '#/components/schemas/OnPremiseLocationType' proximity: anyOf: - $ref: '#/components/schemas/ProximityMode' - type: 'null' radius: anyOf: - type: number - type: 'null' title: Radius sensitivity: type: integer title: Sensitivity location_group_metadata: anyOf: - $ref: '#/components/schemas/app__api__models__LocationGroupMetadata' - type: 'null' type: object required: - id - name - type - proximity - sensitivity title: OnPremiseLocationModel OnPremiseLocationSearchResult: properties: type: $ref: '#/components/schemas/OnPremiseLocationType' id: type: string title: Id name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description sensitivity: anyOf: - $ref: '#/components/schemas/Sensitivity' - type: 'null' location_group_metadata: anyOf: - $ref: '#/components/schemas/app__api__models__LocationGroupMetadata' - type: 'null' type: object required: - type - id - name title: OnPremiseLocationSearchResult OnPremiseLocationType: oneOf: - const: brand title: BRAND - const: category title: CATEGORY - const: location_group title: LOCATION_GROUP type: string enum: - brand - category - location_group title: OnPremiseLocationType x-enum-varnames: - BRAND - CATEGORY - LOCATION_GROUP OperatingSystem: oneOf: - const: ios title: IOS - const: android title: ANDROID - const: others title: OTHERS type: string enum: - ios - android - others title: OperatingSystem x-enum-varnames: - IOS - ANDROID - OTHERS OptimizationStrategy: oneOf: - const: delivery title: DELIVERY - const: click title: CLICK - const: sar title: SAR - const: conversion title: CONVERSION - const: visit title: VISIT type: string enum: - delivery - click - sar - conversion - visit title: OptimizationStrategy x-enum-varnames: - DELIVERY - CLICK - SAR - CONVERSION - VISIT OrderModel: properties: id: type: string title: Id price: type: string title: Price start_date: type: string title: Start Date end_date: type: string title: End Date materials_date: type: string title: Materials Date bill_due_date: type: string title: Bill Due Date cart_id: type: string title: Cart Id cart_item_id: type: string title: Cart Item Id billing_status: type: string title: Billing Status media_type: type: string title: Media Type company_name: type: string title: Company Name account_id: type: integer title: Account Id ad_description: type: string title: Ad Description ad_quantity: type: string title: Ad Quantity ad_run: type: string title: Ad Run summary_title: anyOf: - type: string - type: 'null' title: Summary Title summary_line_1: type: string title: Summary Line 1 summary_line_2: type: string title: Summary Line 2 title: type: string title: Title file_status: type: string title: File Status file_url: type: string title: File Url file_thumb: type: string title: File Thumb flight_status: type: string title: Flight Status invoice_url: type: string title: Invoice Url is_paid: type: boolean title: Is Paid is_cancelled: type: boolean title: Is Cancelled is_overdue: type: boolean title: Is Overdue formatted_price: type: string title: Formatted Price type: object required: - id - price - start_date - end_date - materials_date - bill_due_date - cart_id - cart_item_id - billing_status - media_type - company_name - account_id - ad_description - ad_quantity - ad_run - summary_title - summary_line_1 - summary_line_2 - title - file_status - file_url - file_thumb - flight_status - invoice_url - is_paid - is_cancelled - is_overdue - formatted_price title: OrderModel OrdersModel: properties: total_count: type: integer title: Total Count limit: type: integer title: Limit page_num: type: integer title: Page Num total_pages: type: integer title: Total Pages has_next_page: type: boolean title: Has Next Page has_prev_page: type: boolean title: Has Prev Page items: items: $ref: '#/components/schemas/OrderModel' type: array title: Items type: object required: - total_count - limit - page_num - total_pages - has_next_page - has_prev_page - items title: OrdersModel OrganizationModel: properties: id: type: integer title: Id tenant_id: type: integer title: Tenant Id name: type: string title: Name created_date: anyOf: - type: string format: date-time - type: 'null' title: Created Date updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date type: object required: - id - tenant_id - name title: OrganizationModel OrganizationSearchResult: properties: id: type: integer title: Id name: type: string title: Name tenant_id: type: integer title: Tenant Id tenant_name: type: string title: Tenant Name type: object required: - id - name - tenant_id - tenant_name title: OrganizationSearchResult OrganizationsModel: properties: total_count: type: integer title: Total Count limit: type: integer title: Limit page_num: type: integer title: Page Num total_pages: type: integer title: Total Pages has_next_page: type: boolean title: Has Next Page has_prev_page: type: boolean title: Has Prev Page items: items: $ref: '#/components/schemas/OrganizationModel' type: array title: Items type: object required: - total_count - limit - page_num - total_pages - has_next_page - has_prev_page - items title: OrganizationsModel POIPolygonModel: properties: type: $ref: '#/components/schemas/BlueprintsPolygonTypes' coordinates: anyOf: - items: items: items: items: type: number type: array type: array type: array type: array - items: items: items: type: number type: array type: array type: array title: Coordinates type: object required: - type - coordinates title: POIPolygonModel POISourceSearchBrandModel: properties: category_code: anyOf: - type: string - type: 'null' title: Category Code description: Category code of the brand id: type: integer title: Id description: Brand ID name: type: string title: Name description: Brand name examples: - Foodtown type: object required: - id - name title: POISourceSearchBrandModel POISourceSearchCategoryModel: properties: id: type: string title: Id description: Category ID name: type: string title: Name description: Name of the category examples: - Caribbean Foods type: object required: - id - name title: POISourceSearchCategoryModel POISourceSearchLocationGroupModel: properties: id: type: integer title: Id description: Location group ID name: type: string title: Name description: Location group name description: type: string title: Description description: Location group description tenant_id: type: integer title: Tenant Id description: Tenant ID account_id: anyOf: - type: integer - type: 'null' title: Account Id description: Account ID type: object required: - id - name - description - tenant_id title: POISourceSearchLocationGroupModel POISourceSearchPOIModel: properties: id: type: integer title: Id description: POI ID name: type: string title: Name description: POI name type: object required: - id - name title: POISourceSearchPOIModel POISourceType: oneOf: - const: brand title: BRAND - const: category title: CATEGORY - const: location_group title: LOCATION_GROUP - const: poi title: POI type: string enum: - brand - category - location_group - poi title: POISourceType x-enum-varnames: - BRAND - CATEGORY - LOCATION_GROUP - POI PacingMode: oneOf: - const: 0 title: DEFAULT - const: 1 title: ACCELERATED - const: 2 title: ASAP type: integer enum: - 0 - 1 - 2 title: PacingMode x-enum-varnames: - DEFAULT - ACCELERATED - ASAP PaginatedCreativeAssetsModel: properties: total_count: type: integer title: Total Count limit: type: integer title: Limit page_num: type: integer title: Page Num total_pages: type: integer title: Total Pages has_next_page: type: boolean title: Has Next Page has_prev_page: type: boolean title: Has Prev Page items: items: $ref: '#/components/schemas/CreativeAssetModel' type: array title: Items type: object required: - total_count - limit - page_num - total_pages - has_next_page - has_prev_page - items title: PaginatedCreativeAssetsModel PatchAdgroupModel: properties: name: anyOf: - type: string maxLength: 256 minLength: 1 - type: 'null' title: Name objective: anyOf: - $ref: '#/components/schemas/Objective' - type: 'null' description: Changing objective may clear targeting that does not apply to the new selection; the saved adgroup may not match your request payload. media_types: anyOf: - items: $ref: '#/components/schemas/MediaType' type: array maxItems: 2 minItems: 1 uniqueItems: true - type: 'null' title: Media Types description: 'Currently supported: desktop, ott, audio-streaming, audio-podcast, ctv, web, app. Changing media types may clear targeting that does not apply to the new selection; the saved adgroup may not match your request payload.' bid_price: anyOf: - anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ gt: 0 - type: 'null' title: Bid Price gross_bid_price: anyOf: - anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ gt: 0 - type: 'null' title: Gross Bid Price budgets: anyOf: - items: $ref: '#/components/schemas/BudgetModel-Input' type: array minItems: 1 - type: 'null' title: Budgets drive_to_locations: anyOf: - items: $ref: '#/components/schemas/CreateUpdateDriveToLocationModel' type: array - type: 'null' title: Drive To Locations tracking_pixels: anyOf: - items: $ref: '#/components/schemas/CreateUpdateTrackingPixelModel' type: array - type: 'null' title: Tracking Pixels status: anyOf: - type: integer enum: - 2 - 1 - type: 'null' title: Status bid_type: anyOf: - $ref: '#/components/schemas/app__api__routes__constants__BidType' - type: 'null' dayparting: anyOf: - items: type: integer exclusiveMaximum: 336.0 minimum: 0.0 type: array uniqueItems: true - type: 'null' title: Dayparting description: Each number in the list represents a half hour in a week. 0 is the first half hour (12am - 12:30am) on Sunday. 335 is the last half hour (11:30pm - 12am) on Saturday. pacing_mode: anyOf: - $ref: '#/components/schemas/PacingMode' - type: 'null' description: Spend pacing for the ad group. Omitted defaults to standard (DEFAULT) pacing. rotate_creatives_evenly: anyOf: - type: boolean - type: 'null' title: Rotate Creatives Evenly type: object title: PatchAdgroupModel PatchCreativeModel: properties: name: anyOf: - type: string maxLength: 128 minLength: 1 - type: 'null' title: Name status: anyOf: - $ref: '#/components/schemas/CreativeStatus' - type: 'null' start_date: anyOf: - type: string format: date - type: 'null' title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date freq_cap_duration: anyOf: - type: integer maximum: 126.0 minimum: 1.0 - type: 'null' title: Freq Cap Duration freq_cap_value: anyOf: - type: integer maximum: 32766.0 minimum: 1.0 - type: 'null' title: Freq Cap Value rotation_weight: anyOf: - type: integer maximum: 32766.0 minimum: 1.0 - type: 'null' title: Rotation Weight click_through_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Click Through Url third_party_placement_id: anyOf: - type: string maxLength: 128 - type: 'null' title: Third Party Placement Id type: object title: PatchCreativeModel PatchCreativesModel: properties: creatives: items: $ref: '#/components/schemas/MultiPatchCreativeModel' type: array minItems: 1 title: Creatives type: object required: - creatives title: PatchCreativesModel PaymentType: oneOf: - const: 0 title: INVOICE - const: 1 title: CREDIT_CARD - const: 2 title: SPEND_LIMIT - const: 3 title: CREDIT_CARD_V2 - const: 4 title: ACCOUNT_LEVEL_CREDIT_CARD type: integer enum: - 0 - 1 - 2 - 3 - 4 title: PaymentType x-enum-varnames: - INVOICE - CREDIT_CARD - SPEND_LIMIT - CREDIT_CARD_V2 - ACCOUNT_LEVEL_CREDIT_CARD PerformanceDistributionAdgroupModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name product: anyOf: - type: string - type: 'null' title: Product description: Product bucket impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Total spend (gross revenue) ctr: type: number title: Ctr description: Click-through rate (percentage) cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Click-to-call actions directions: type: number title: Directions description: Directions actions website: type: number title: Website description: Website actions moreinfo: type: number title: Moreinfo description: More info actions coupon: type: number title: Coupon description: Coupon actions video: type: number title: Video description: Video actions cumulative_reach: type: number title: Cumulative Reach description: Cumulative reach visits: type: number title: Visits description: Visits open_hour_visits: type: number title: Open Hour Visits description: Open hour visits projected_visits: type: integer title: Projected Visits description: Projected visits, -1 when negative projected_open_hour_visits: type: integer title: Projected Open Hour Visits description: Projected open hour visits, -1 when negative type: object required: - account_name - campaign_id - campaign_name - adgroup_id - adgroup_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video - cumulative_reach - visits - open_hour_visits - projected_visits - projected_open_hour_visits title: PerformanceDistributionAdgroupModel description: Performance distribution row for an ad group product breakdown. PerformanceDistributionCampaignModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID when all_adgroups=true adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name when all_adgroups=true product: anyOf: - type: string - type: 'null' title: Product description: Product breakdown bucket impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Total spend (gross revenue) ctr: type: number title: Ctr description: Click-through rate (percentage) cpm: type: number title: Cpm description: Cost per thousand impressions total_sa: type: number title: Total Sa description: Total secondary actions sar: type: number title: Sar description: Secondary action rate click_to_call: type: number title: Click To Call description: Click-to-call actions directions: type: number title: Directions description: Directions actions website: type: number title: Website description: Website actions moreinfo: type: number title: Moreinfo description: More info actions coupon: type: number title: Coupon description: Coupon actions video: type: number title: Video description: Video actions cumulative_reach: type: number title: Cumulative Reach description: Cumulative reach visits: type: number title: Visits description: Visits open_hour_visits: type: number title: Open Hour Visits description: Open hour visits projected_visits: type: integer title: Projected Visits description: Projected visits, -1 when negative projected_open_hour_visits: type: integer title: Projected Open Hour Visits description: Projected open hour visits, -1 when negative type: object required: - account_name - campaign_id - campaign_name - impressions - clicks - spend - ctr - cpm - total_sa - sar - click_to_call - directions - website - moreinfo - coupon - video - cumulative_reach - visits - open_hour_visits - projected_visits - projected_open_hour_visits title: PerformanceDistributionCampaignModel description: Performance distribution row for a campaign (product breakdown, key=1). PerformanceDistributionKey: type: integer enum: - 1 - 2 title: PerformanceDistributionKey description: Breakdown dimension for performance distribution (Rocket key query param). PixelCampaignFieldName: oneOf: - const: conversions title: CONVERSIONS - const: view_conversions title: VIEW_CONVERSIONS - const: click_conversions title: CLICK_CONVERSIONS type: string enum: - conversions - view_conversions - click_conversions title: PixelCampaignFieldName x-enum-varnames: - CONVERSIONS - VIEW_CONVERSIONS - CLICK_CONVERSIONS PixelConversionModel: properties: pixel_id: type: integer title: Pixel Id description: Pixel ID pixel_name: anyOf: - type: string - type: 'null' title: Pixel Name conversions: type: number title: Conversions description: Total number of conversions view_conversions: type: number title: View Conversions description: Number of view-through conversions click_conversions: type: number title: Click Conversions description: Number of click-through conversions type: object required: - pixel_id - conversions - view_conversions - click_conversions title: PixelConversionModel ProductInsightsCampaignAdgroupsModel: properties: product_group: type: string title: Product Group description: Product group display name (e.g. Location Targeting, Audience). product: type: string title: Product description: Product display name (e.g. Geotargeting, GT Audience). constraint: anyOf: - type: string - type: 'null' title: Constraint description: Targeting constraint name (e.g. geotargeting, audience name). adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID. adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group display name. poi_name: anyOf: - type: string - type: 'null' title: Poi Name description: Point of interest (POI) or business name. dma_name: anyOf: - type: string - type: 'null' title: Dma Name description: DMA display name. address: anyOf: - type: string - type: 'null' title: Address description: Street address of the POI. county_name: anyOf: - type: string - type: 'null' title: County Name description: County display name. city: anyOf: - type: string - type: 'null' title: City description: City of the POI. state: anyOf: - type: string - type: 'null' title: State description: State or region of the POI. zip: anyOf: - type: string - type: 'null' title: Zip description: ZIP or postal code of the POI. country: anyOf: - type: string - type: 'null' title: Country description: Country code. latitude: anyOf: - type: number - type: 'null' title: Latitude description: Latitude. longitude: anyOf: - type: number - type: 'null' title: Longitude description: Longitude. imp: anyOf: - type: number - type: 'null' title: Imp description: Impressions. clks: anyOf: - type: number - type: 'null' title: Clks description: Clicks. sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions (e.g. website, directions, call). spt: anyOf: - type: number - type: 'null' title: Spt description: Spend (xad_gross_revenue). vst: anyOf: - type: number - type: 'null' title: Vst description: Store visits. oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Open-hour store visits. ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate (clicks / impressions). sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate (secondary actions / clicks). vr: anyOf: - type: number - type: 'null' title: Vr description: Visit rate (visits / impressions). prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected store visits. prj_oh_vst: anyOf: - type: number - type: 'null' title: Prj Oh Vst description: Projected open-hour store visits. web: anyOf: - type: number - type: 'null' title: Web description: Website secondary actions. dir: anyOf: - type: number - type: 'null' title: Dir description: Directions secondary actions. ctc: anyOf: - type: number - type: 'null' title: Ctc description: Click-to-call secondary actions. info: anyOf: - type: number - type: 'null' title: Info description: More info secondary actions. cpn: anyOf: - type: number - type: 'null' title: Cpn description: Coupon secondary actions. vid_0: anyOf: - type: number - type: 'null' title: Vid 0 description: Video start (first frame) count. vid_25: anyOf: - type: number - type: 'null' title: Vid 25 description: Video first quartile (25%) count. vid_50: anyOf: - type: number - type: 'null' title: Vid 50 description: Video midpoint (50%) count. vid_75: anyOf: - type: number - type: 'null' title: Vid 75 description: Video third quartile (75%) count. vid_100: anyOf: - type: number - type: 'null' title: Vid 100 description: Video end (100%) count. vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate (video_end / video_start). type: object required: - product_group - product title: ProductInsightsCampaignAdgroupsModel ProductInsightsCampaignCreativesModel: properties: organization_name: anyOf: - type: string - type: 'null' title: Organization Name description: Organization display name. account_id: anyOf: - type: integer - type: 'null' title: Account Id description: Account ID. account_name: anyOf: - type: string - type: 'null' title: Account Name description: Account display name. campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id description: Campaign ID. campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name description: Campaign display name. adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID. adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group display name. product_group: type: string title: Product Group description: Product group display name (e.g. Location Targeting, Audience). product: type: string title: Product description: Product display name (e.g. Geotargeting, GT Audience). constraint: anyOf: - type: string - type: 'null' title: Constraint description: Targeting constraint name (e.g. geotargeting, audience name). creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID. creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative display name. poi_name: anyOf: - type: string - type: 'null' title: Poi Name description: Point of interest (POI) or business name. address: anyOf: - type: string - type: 'null' title: Address description: Street address of the POI. city: anyOf: - type: string - type: 'null' title: City description: City of the POI. state: anyOf: - type: string - type: 'null' title: State description: State or region of the POI. zip: anyOf: - type: string - type: 'null' title: Zip description: ZIP or postal code of the POI. dma_name: anyOf: - type: string - type: 'null' title: Dma Name description: DMA display name. county_name: anyOf: - type: string - type: 'null' title: County Name description: County display name. country: anyOf: - type: string - type: 'null' title: Country description: Country code. latitude: anyOf: - type: number - type: 'null' title: Latitude description: Latitude. longitude: anyOf: - type: number - type: 'null' title: Longitude description: Longitude. imp: anyOf: - type: number - type: 'null' title: Imp description: Impressions. clks: anyOf: - type: number - type: 'null' title: Clks description: Clicks. sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions (e.g. website, directions, call). spt: anyOf: - type: number - type: 'null' title: Spt description: Spend (xad_gross_revenue). vst: anyOf: - type: number - type: 'null' title: Vst description: Store visits. oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Open-hour store visits. ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate (clicks / impressions). sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate (secondary actions / clicks). vr: anyOf: - type: number - type: 'null' title: Vr description: Visit rate (visits / impressions). prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected store visits. prj_oh_vst: anyOf: - type: number - type: 'null' title: Prj Oh Vst description: Projected open-hour store visits. web: anyOf: - type: number - type: 'null' title: Web description: Website secondary actions. dir: anyOf: - type: number - type: 'null' title: Dir description: Directions secondary actions. ctc: anyOf: - type: number - type: 'null' title: Ctc description: Click-to-call secondary actions. info: anyOf: - type: number - type: 'null' title: Info description: More info secondary actions. cpn: anyOf: - type: number - type: 'null' title: Cpn description: Coupon secondary actions. vid_0: anyOf: - type: number - type: 'null' title: Vid 0 description: Video start (first frame) count. vid_25: anyOf: - type: number - type: 'null' title: Vid 25 description: Video first quartile (25%) count. vid_50: anyOf: - type: number - type: 'null' title: Vid 50 description: Video midpoint (50%) count. vid_75: anyOf: - type: number - type: 'null' title: Vid 75 description: Video third quartile (75%) count. vid_100: anyOf: - type: number - type: 'null' title: Vid 100 description: Video end (100%) count. vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate (video_end / video_start). type: object required: - product_group - product title: ProductInsightsCampaignCreativesModel ProductInsightsCampaignFieldName: oneOf: - const: imp title: IMP - const: spt title: SPT - const: vst title: VST - const: oh_vst title: OH_VST - const: clks title: CLKS - const: ctr title: CTR - const: sa title: SA - const: sar title: SAR - const: vr title: VR - const: prj_vst title: PRJ_VST - const: prj_oh_vst title: PRJ_OH_VST - const: vcr title: VCR - const: product_group title: PRODUCT_GROUP - const: product title: PRODUCT - const: constraint title: CONSTRAINT type: string enum: - imp - spt - vst - oh_vst - clks - ctr - sa - sar - vr - prj_vst - prj_oh_vst - vcr - product_group - product - constraint title: ProductInsightsCampaignFieldName x-enum-varnames: - IMP - SPT - VST - OH_VST - CLKS - CTR - SA - SAR - VR - PRJ_VST - PRJ_OH_VST - VCR - PRODUCT_GROUP - PRODUCT - CONSTRAINT ProductInsightsCampaignModel: properties: product_group: type: string title: Product Group description: Product group display name (e.g. Location Targeting, Audience). product: type: string title: Product description: Product display name (e.g. Geotargeting, GT Audience). constraint: anyOf: - type: string - type: 'null' title: Constraint description: Targeting constraint name (e.g. geotargeting, audience name). campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name description: Campaign display name. poi_name: anyOf: - type: string - type: 'null' title: Poi Name description: Point of interest or geotarget display name. dma_name: anyOf: - type: string - type: 'null' title: Dma Name description: DMA display name. address: anyOf: - type: string - type: 'null' title: Address description: Street address. county_name: anyOf: - type: string - type: 'null' title: County Name description: County display name. city: anyOf: - type: string - type: 'null' title: City description: City. state: anyOf: - type: string - type: 'null' title: State description: State or region. zip: anyOf: - type: string - type: 'null' title: Zip description: ZIP or postal code. country: anyOf: - type: string - type: 'null' title: Country description: Country code. latitude: anyOf: - type: number - type: 'null' title: Latitude description: Latitude. longitude: anyOf: - type: number - type: 'null' title: Longitude description: Longitude. imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions spt: anyOf: - type: number - type: 'null' title: Spt description: Spent vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate vr: anyOf: - type: number - type: 'null' title: Vr description: Visit rate prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected visits prj_oh_vst: anyOf: - type: number - type: 'null' title: Prj Oh Vst description: Projected open hour visits web: anyOf: - type: number - type: 'null' title: Web dir: anyOf: - type: number - type: 'null' title: Dir ctc: anyOf: - type: number - type: 'null' title: Ctc info: anyOf: - type: number - type: 'null' title: Info cpn: anyOf: - type: number - type: 'null' title: Cpn vid_0: anyOf: - type: number - type: 'null' title: Vid 0 vid_25: anyOf: - type: number - type: 'null' title: Vid 25 vid_50: anyOf: - type: number - type: 'null' title: Vid 50 vid_75: anyOf: - type: number - type: 'null' title: Vid 75 vid_100: anyOf: - type: number - type: 'null' title: Vid 100 vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - product_group - product title: ProductInsightsCampaignModel ProximityMode: oneOf: - const: in_store title: IN_STORE - const: on_lot title: ON_LOT - const: retail_block title: RETAIL_BLOCK - const: radial title: RADIAL type: string enum: - in_store - on_lot - retail_block - radial title: ProximityMode x-enum-varnames: - IN_STORE - ON_LOT - RETAIL_BLOCK - RADIAL PublisherCategoriesModel: properties: items: items: $ref: '#/components/schemas/app__api__routes__static__models__PublisherCategoryModel' type: array title: Items type: object required: - items title: PublisherCategoriesModel PublisherDomainModel: properties: domain: type: string minLength: 1 title: Domain exclude: type: boolean title: Exclude type: object required: - domain - exclude title: PublisherDomainModel PublisherTier: oneOf: - const: 4 title: EXCHANGE - const: 6 title: CUSTOM type: integer enum: - 4 - 6 title: PublisherTier x-enum-varnames: - EXCHANGE - CUSTOM PublishersModel: properties: items: items: $ref: '#/components/schemas/app__api__routes__static__models__PublisherModel' type: array title: Items type: object required: - items title: PublishersModel RecommendationCountModel: properties: campaign_id: type: integer title: Campaign Id recommendation_count: type: integer title: Recommendation Count type: object required: - campaign_id - recommendation_count title: RecommendationCountModel RecommendationCountRequestModel: properties: campaign_ids: items: type: integer type: array maxItems: 100 minItems: 1 title: Campaign Ids description: List of campaign IDs type: object required: - campaign_ids title: RecommendationCountRequestModel RecommendationModel: properties: campaign_id: type: integer title: Campaign Id adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id recommendation_id: type: integer title: Recommendation Id rule_id: type: string title: Rule Id priority: type: integer title: Priority agent_name: type: string title: Agent Name recommendation_type: type: string title: Recommendation Type message_header: type: string title: Message Header message_title: anyOf: - type: string - type: 'null' title: Message Title message: type: string title: Message recommendation_cta: anyOf: - type: string - type: 'null' title: Recommendation Cta recommendation_cta_v2: anyOf: - type: string - type: 'null' title: Recommendation Cta V2 status: $ref: '#/components/schemas/RecommendationStatus' auto_fixable: type: boolean title: Auto Fixable readOnly: true type: object required: - campaign_id - recommendation_id - rule_id - priority - agent_name - recommendation_type - message_header - message - status - auto_fixable title: RecommendationModel RecommendationStatus: oneOf: - const: new title: NEW - const: dismissed title: DISMISSED - const: resolved title: RESOLVED type: string enum: - new - dismissed - resolved title: RecommendationStatus x-enum-varnames: - NEW - DISMISSED - RESOLVED RecommendationsModel: properties: recommendations: items: $ref: '#/components/schemas/RecommendationModel' type: array title: Recommendations type: object required: - recommendations title: RecommendationsModel SearchAccountsRequestModel: properties: search_text: type: string minLength: 1 title: Search Text limit: type: integer maximum: 10000.0 minimum: 1.0 title: Limit default: 50 created_since: anyOf: - type: integer - type: 'null' title: Created Since description: Filter by account creation Unix timestamp type: object required: - search_text title: SearchAccountsRequestModel SearchAccountsResultsModel: properties: items: items: $ref: '#/components/schemas/AccountSearchResult' type: array title: Items type: object required: - items title: SearchAccountsResultsModel SearchAdPackagesResultsModel: properties: items: items: $ref: '#/components/schemas/AdPackageSearchResult' type: array title: Items type: object required: - items title: SearchAdPackagesResultsModel SearchAdgroupsRequestModel: properties: search_text: type: string minLength: 1 title: Search Text limit: type: integer maximum: 10000.0 minimum: 1.0 title: Limit default: 50 created_since: anyOf: - type: integer - type: 'null' title: Created Since description: Filter by ad group creation Unix timestamp updated_since: anyOf: - type: integer - type: 'null' title: Updated Since description: Filter by ad group last updated Unix timestamp started_since: anyOf: - type: integer - type: 'null' title: Started Since description: Filter by ad group start Unix timestamp type: object required: - search_text title: SearchAdgroupsRequestModel SearchAdgroupsResultsModel: properties: items: items: $ref: '#/components/schemas/AdgroupSearchResult' type: array title: Items type: object required: - items title: SearchAdgroupsResultsModel SearchAudiencesRequestModel: properties: search_text: type: string minLength: 1 title: Search Text type: object required: - search_text title: SearchAudiencesRequestModel SearchAudiencesResultsModel: properties: items: items: $ref: '#/components/schemas/AudienceSearchResult' type: array title: Items type: object required: - items title: SearchAudiencesResultsModel SearchCampaignsRequestModel: properties: search_text: type: string minLength: 1 title: Search Text limit: type: integer maximum: 10000.0 minimum: 1.0 title: Limit default: 50 account_id: anyOf: - type: integer - type: 'null' title: Account Id description: Filter by account ID created_since: anyOf: - type: integer - type: 'null' title: Created Since description: Filter by campaign creation Unix timestamp updated_since: anyOf: - type: integer - type: 'null' title: Updated Since description: Filter by campaign last updated Unix timestamp started_since: anyOf: - type: integer - type: 'null' title: Started Since description: Filter by campaign start Unix timestamp type: object required: - search_text title: SearchCampaignsRequestModel SearchCampaignsResultsModel: properties: items: items: $ref: '#/components/schemas/CampaignSearchResult' type: array title: Items type: object required: - items title: SearchCampaignsResultsModel SearchCreativesRequestModel: properties: search_text: type: string minLength: 1 title: Search Text limit: type: integer maximum: 10000.0 minimum: 1.0 title: Limit default: 50 updated_since: anyOf: - type: integer - type: 'null' title: Updated Since description: Filter by creative last updated Unix timestamp started_since: anyOf: - type: integer - type: 'null' title: Started Since description: Filter by creative start Unix timestamp type: object required: - search_text title: SearchCreativesRequestModel SearchCreativesResultsModel: properties: items: items: $ref: '#/components/schemas/CreativeSearchResult' type: array title: Items type: object required: - items title: SearchCreativesResultsModel SearchDriveToLocationsRequestModel: properties: search_text: type: string minLength: 1 title: Search Text limit: type: integer maximum: 10000.0 minimum: 1.0 title: Limit default: 50 country_code: $ref: '#/components/schemas/CountryCode' type: object required: - search_text - country_code title: SearchDriveToLocationsRequestModel SearchLocationFiltersRequestModel: properties: search_text: type: string minLength: 1 title: Search Text limit: type: integer maximum: 10000.0 minimum: 1.0 title: Limit default: 50 country_code: $ref: '#/components/schemas/CountryCode' types: anyOf: - items: $ref: '#/components/schemas/LocationFilterType' type: array - type: 'null' title: Types type: object required: - search_text - country_code title: SearchLocationFiltersRequestModel SearchLocationFiltersResultsModel: properties: city: anyOf: - items: $ref: '#/components/schemas/LocationFilterSearchResultModel' type: array - type: 'null' title: City state: anyOf: - items: $ref: '#/components/schemas/LocationFilterSearchResultModel' type: array - type: 'null' title: State zip: anyOf: - items: $ref: '#/components/schemas/LocationFilterSearchResultModel' type: array - type: 'null' title: Zip address: anyOf: - items: $ref: '#/components/schemas/LocationFilterSearchResultModel' type: array - type: 'null' title: Address latlng: anyOf: - items: $ref: '#/components/schemas/LocationFilterSearchResultModel' type: array - type: 'null' title: Latlng county: anyOf: - items: $ref: '#/components/schemas/LocationFilterSearchResultModel' type: array - type: 'null' title: County dma: anyOf: - items: $ref: '#/components/schemas/LocationFilterSearchResultModel' type: array - type: 'null' title: Dma type: object title: SearchLocationFiltersResultsModel SearchLocationGroupPOIsPositionModel: properties: lat: type: number title: Lat description: Latitude lng: type: number title: Lng description: Longitude type: object required: - lat - lng title: SearchLocationGroupPOIsPositionModel SearchLocationGroupPOIsRequestModel: properties: search_text: type: string maxLength: 200 minLength: 1 title: Search Text description: Business name and/or address to search limit: type: integer maximum: 100.0 minimum: 1.0 title: Limit description: Maximum number of results to return default: 50 type: object required: - search_text title: SearchLocationGroupPOIsRequestModel SearchLocationGroupPOIsResponseModel: properties: pois: items: $ref: '#/components/schemas/SearchLocationGroupPOIsResultModel' type: array title: Pois description: POI and address search results type: object title: SearchLocationGroupPOIsResponseModel SearchLocationGroupPOIsResultModel: properties: poi_id: type: integer title: Poi Id description: Unique POI identifier name: type: string title: Name description: POI or business name display_form: type: string title: Display Form description: Formatted address for display brand_id: anyOf: - type: integer - type: 'null' title: Brand Id description: Brand identifier brand_name: anyOf: - type: string - type: 'null' title: Brand Name description: Brand name city: type: string title: City description: City name default: '' state: type: string title: State description: State or province name default: '' state_code: type: string title: State Code description: State or province code default: '' postal_code: type: string title: Postal Code description: Postal or ZIP code default: '' country_code: type: string title: Country Code description: Country code default: '' position: $ref: '#/components/schemas/SearchLocationGroupPOIsPositionModel' description: Geographic position of the POI match_score: anyOf: - type: number - type: 'null' title: Match Score description: Search match score brand_logo_url: anyOf: - type: string - type: 'null' title: Brand Logo Url description: Brand logo URL category_icon_url: anyOf: - type: string - type: 'null' title: Category Icon Url description: Category icon URL polygon_exists: anyOf: - type: boolean - type: 'null' title: Polygon Exists description: Whether a polygon exists for the POI tenant_id: anyOf: - type: integer - type: 'null' title: Tenant Id description: Tenant that owns the POI (0 = global) type: object required: - poi_id - name - display_form - position title: SearchLocationGroupPOIsResultModel SearchLocationGroupsRequestModel: properties: location_group_ids: items: type: string type: array title: Location Group Ids description: List of location group IDs to search for type: object required: - location_group_ids title: SearchLocationGroupsRequestModel SearchLocationGroupsResultsModel: properties: items: items: $ref: '#/components/schemas/LocationGroupResult' type: array title: Items type: object required: - items title: SearchLocationGroupsResultsModel SearchNeighborhoodsRequestModel: properties: search_text: type: string minLength: 1 title: Search Text limit: type: integer maximum: 10000.0 minimum: 1.0 title: Limit default: 50 country_code: $ref: '#/components/schemas/CountryCode' type: object required: - search_text - country_code title: SearchNeighborhoodsRequestModel SearchOnPremiseLocationsRequestModel: properties: search_text: type: string minLength: 1 title: Search Text limit: type: integer maximum: 10000.0 minimum: 1.0 title: Limit default: 50 country_code: $ref: '#/components/schemas/CountryCode' type: object required: - search_text - country_code title: SearchOnPremiseLocationsRequestModel SearchOrganizationsResultsModel: properties: items: items: $ref: '#/components/schemas/OrganizationSearchResult' type: array title: Items type: object required: - items title: SearchOrganizationsResultsModel SearchPOISourcesCountItemModel: properties: type: $ref: '#/components/schemas/POISourceType' count: type: integer title: Count category_id: anyOf: - type: string - type: 'null' title: Category Id brand_id: anyOf: - type: integer - type: 'null' title: Brand Id location_group_id: anyOf: - type: integer - type: 'null' title: Location Group Id poi_id: anyOf: - type: integer - type: 'null' title: Poi Id type: object required: - type - count title: SearchPOISourcesCountItemModel SearchPOISourcesCountResponseModel: properties: items: items: $ref: '#/components/schemas/SearchPOISourcesCountItemModel' type: array title: Items description: List of sources with POIs count if available type: object title: SearchPOISourcesCountResponseModel SearchPOISourcesPreviewItemModel: properties: city: type: string title: City zipcode: type: string title: Zipcode state: type: string title: State description: State code address: type: string title: Address poi_id: type: integer title: Poi Id company_name: type: string title: Company Name type: object required: - city - zipcode - state - address - poi_id - company_name title: SearchPOISourcesPreviewItemModel SearchPOISourcesPreviewPOIsRequestModel: properties: brand_ids: items: type: integer type: array uniqueItems: true title: Brand Ids description: Brands to filter by category_ids: items: type: string type: array uniqueItems: true title: Category Ids description: Categories to filter by location_group_ids: items: type: integer type: array uniqueItems: true title: Location Group Ids description: Location groups to filter by poi_ids: items: type: integer type: array uniqueItems: true title: Poi Ids description: POIs to filter by states: items: type: string type: array uniqueItems: true title: States description: States to filter by cities: items: type: string type: array uniqueItems: true title: Cities description: Cities to filter by dma_ids: items: type: integer type: array uniqueItems: true title: Dma Ids description: DMAs to filter by zipcodes: items: type: string type: array uniqueItems: true title: Zipcodes description: Zipcodes to filter by city_state_pairs: items: type: string type: array uniqueItems: true title: City State Pairs description: City, State pairs to filter by exclude_pois: items: type: integer type: array uniqueItems: true title: Exclude Pois description: POIs to exclude from the results limit: type: integer maximum: 100.0 minimum: 1.0 title: Limit default: 10 page_num: type: integer minimum: 1.0 title: Page Num default: 1 type: object title: SearchPOISourcesPreviewPOIsRequestModel SearchPOISourcesPreviewResponseModel: properties: items: items: $ref: '#/components/schemas/SearchPOISourcesPreviewItemModel' type: array title: Items description: List of POIs preview for selected sources type: object title: SearchPOISourcesPreviewResponseModel SearchPOISourcesRequestModel: properties: brand_ids: items: type: integer type: array uniqueItems: true title: Brand Ids description: Brands to filter by category_ids: items: type: string type: array uniqueItems: true title: Category Ids description: Categories to filter by location_group_ids: items: type: integer type: array uniqueItems: true title: Location Group Ids description: Location groups to filter by poi_ids: items: type: integer type: array uniqueItems: true title: Poi Ids description: POIs to filter by states: items: type: string type: array uniqueItems: true title: States description: States to filter by cities: items: type: string type: array uniqueItems: true title: Cities description: Cities to filter by dma_ids: items: type: integer type: array uniqueItems: true title: Dma Ids description: DMAs to filter by zipcodes: items: type: string type: array uniqueItems: true title: Zipcodes description: Zipcodes to filter by city_state_pairs: items: type: string type: array uniqueItems: true title: City State Pairs description: City, State pairs to filter by type: object title: SearchPOISourcesRequestModel SearchPOISourcesResponseModel: properties: brands: items: $ref: '#/components/schemas/POISourceSearchBrandModel' type: array title: Brands categories: items: $ref: '#/components/schemas/POISourceSearchCategoryModel' type: array title: Categories location_groups: items: $ref: '#/components/schemas/POISourceSearchLocationGroupModel' type: array title: Location Groups pois: items: $ref: '#/components/schemas/POISourceSearchPOIModel' type: array title: Pois type: object title: SearchPOISourcesResponseModel SearchPOIsCityLocationFilterResponseModel: properties: id: type: string title: Id name: type: string title: Name state_id: type: integer title: State Id state_code: type: string title: State Code state_name: type: string title: State Name country_code: $ref: '#/components/schemas/CountryCode' country_name: type: string title: Country Name type: object required: - id - name - state_id - state_code - state_name - country_code - country_name title: SearchPOIsCityLocationFilterResponseModel SearchPOIsDMALocationFilterResponseModel: properties: id: type: string title: Id name: type: string title: Name type: object required: - id - name title: SearchPOIsDMALocationFilterResponseModel SearchPOIsLocationFiltersResponseModel: properties: cities: items: $ref: '#/components/schemas/SearchPOIsCityLocationFilterResponseModel' type: array title: Cities description: List of cities states: items: $ref: '#/components/schemas/SearchPOIsStateLocationFilterResponseModel' type: array title: States description: List of states zipcodes: items: $ref: '#/components/schemas/SearchPOIsZipCodeLocationFilterResponseModel' type: array title: Zipcodes description: List of zipcodes dmas: items: $ref: '#/components/schemas/SearchPOIsDMALocationFilterResponseModel' type: array title: Dmas description: List of DMAs type: object title: SearchPOIsLocationFiltersResponseModel SearchPOIsStateLocationFilterResponseModel: properties: id: type: string title: Id name: type: string title: Name state_code: type: string title: State Code country_code: $ref: '#/components/schemas/CountryCode' country_name: type: string title: Country Name type: object required: - id - name - state_code - country_code - country_name title: SearchPOIsStateLocationFilterResponseModel SearchPOIsZipCodeLocationFilterResponseModel: properties: id: type: string title: Id name: type: string title: Name country_code: $ref: '#/components/schemas/CountryCode' type: object required: - id - name - country_code title: SearchPOIsZipCodeLocationFilterResponseModel SearchRequestModel: properties: search_text: type: string minLength: 1 title: Search Text limit: type: integer maximum: 10000.0 minimum: 1.0 title: Limit default: 50 type: object required: - search_text title: SearchRequestModel SearchTenantsResultsModel: properties: items: items: $ref: '#/components/schemas/TenantSearchResult' type: array title: Items type: object required: - items title: SearchTenantsResultsModel Sensitivity: oneOf: - const: 0 title: WHITELIST - const: 1 title: GRAYLIST - const: 2 title: SEMI_SENSITIVE - const: 3 title: BLACKLIST type: integer enum: - 0 - 1 - 2 - 3 title: Sensitivity x-enum-varnames: - WHITELIST - GRAYLIST - SEMI_SENSITIVE - BLACKLIST SignupModel: properties: first_name: type: string maxLength: 64 minLength: 1 title: First Name last_name: type: string maxLength: 64 minLength: 1 title: Last Name company_name: type: string maxLength: 64 title: Company Name business_type: $ref: '#/components/schemas/BusinessType' website: type: string maxLength: 2083 minLength: 1 format: uri title: Website country_code: $ref: '#/components/schemas/CountryCode' email: type: string format: email title: Email password: type: string title: Password type: object required: - first_name - last_name - company_name - business_type - website - country_code - email - password title: SignupModel SignupResponseModel: properties: user_id: type: integer title: User Id tenant_id: type: integer title: Tenant Id organization_id: type: integer title: Organization Id account_id: type: integer title: Account Id type: object required: - user_id - tenant_id - organization_id - account_id title: SignupResponseModel SortOrder: oneOf: - const: desc title: DESC - const: asc title: ASC type: string enum: - desc - asc title: SortOrder x-enum-varnames: - DESC - ASC StandardSuperLandingPage-Input: properties: type: type: integer enum: - 1 - 2 title: Type header_image_url: type: string maxLength: 2083 minLength: 1 format: uri title: Header Image Url description: Must be 640x400 or proportional header_click_through_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Header Click Through Url button_color: anyOf: - type: string pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ examples: - FFAA74 - 01AB23CD - type: 'null' title: Button Color directions_button_label: anyOf: - type: string - type: 'null' title: Directions Button Label call_button_label: anyOf: - type: string - type: 'null' title: Call Button Label additional_button_click_through_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Additional Button Click Through Url additional_button_text: anyOf: - type: string - type: 'null' title: Additional Button Text coupon_image_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Coupon Image Url description: Must be 750x704 or proportional coupon_click_through_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Coupon Click Through Url youtube_video_id: anyOf: - type: string - type: 'null' title: Youtube Video Id description: The `v` query parameter from a Youtube video URL footer_title: anyOf: - type: string - type: 'null' title: Footer Title footer_text: anyOf: - type: string - type: 'null' title: Footer Text flip_coupon_and_video: type: boolean title: Flip Coupon And Video description: If true, the coupon will appear above the Youtube video default: false type: object required: - type - header_image_url title: StandardSuperLandingPage StandardSuperLandingPage-Output: properties: type: type: integer enum: - 1 - 2 title: Type header_image_url: type: string title: Header Image Url description: Must be 640x400 or proportional header_click_through_url: anyOf: - type: string - type: 'null' title: Header Click Through Url button_color: anyOf: - type: string pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ examples: - FFAA74 - 01AB23CD - type: 'null' title: Button Color directions_button_label: anyOf: - type: string - type: 'null' title: Directions Button Label call_button_label: anyOf: - type: string - type: 'null' title: Call Button Label additional_button_click_through_url: anyOf: - type: string - type: 'null' title: Additional Button Click Through Url additional_button_text: anyOf: - type: string - type: 'null' title: Additional Button Text coupon_image_url: anyOf: - type: string - type: 'null' title: Coupon Image Url description: Must be 750x704 or proportional coupon_click_through_url: anyOf: - type: string - type: 'null' title: Coupon Click Through Url youtube_video_id: anyOf: - type: string - type: 'null' title: Youtube Video Id description: The `v` query parameter from a Youtube video URL footer_title: anyOf: - type: string - type: 'null' title: Footer Title footer_text: anyOf: - type: string - type: 'null' title: Footer Text flip_coupon_and_video: type: boolean title: Flip Coupon And Video description: If true, the coupon will appear above the Youtube video default: false type: object required: - type - header_image_url title: StandardSuperLandingPage StateModel: properties: id: type: integer title: Id code: type: string title: Code name: type: string title: Name type: object required: - id - code - name title: StateModel StatesModel: properties: items: items: $ref: '#/components/schemas/StateModel' type: array title: Items type: object required: - items title: StatesModel Status: oneOf: - const: 1 title: ACTIVE - const: 2 title: PAUSED - const: 7 title: INCOMPLETE - const: 10 title: DRAFT - const: 11 title: REJECTED - const: 12 title: SUBMITTED type: integer enum: - 1 - 2 - 7 - 10 - 11 - 12 title: Status x-enum-varnames: - ACTIVE - PAUSED - INCOMPLETE - DRAFT - REJECTED - SUBMITTED StreamingVideoContentCategoriesModel: properties: items: items: $ref: '#/components/schemas/app__api__routes__static__models__StreamingVideoContentCategoryModel' type: array title: Items type: object required: - items title: StreamingVideoContentCategoriesModel SuccessResponseModel: properties: success: type: boolean title: Success default: true type: object title: SuccessResponseModel SupplySystemDistributionCampaignModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID when all_adgroups=true or publisher breakdown adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name when all_adgroups=true or publisher breakdown device_type: anyOf: - type: string - type: 'null' title: Device Type description: Device type bucket (returned when key=device, 1) os: anyOf: - type: string - type: 'null' title: Os description: Operating system bucket (returned when key=os, 2) pub_type: anyOf: - type: string - type: 'null' title: Pub Type description: Publisher type bucket (returned when key=publisher_type, 3) impressions: type: number title: Impressions description: Total impressions clicks: type: number title: Clicks description: Total clicks spend: type: number title: Spend description: Total spend (gross revenue) ctr: type: number title: Ctr description: Click-through rate (percentage) cpm: anyOf: - type: number - type: 'null' title: Cpm description: Cost per thousand impressions (device/os breakdown only) total_sa: anyOf: - type: number - type: 'null' title: Total Sa description: Total secondary actions (device/os breakdown only) sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate (device/os breakdown only) click_to_call: anyOf: - type: number - type: 'null' title: Click To Call description: Click-to-call actions (device/os breakdown only) directions: anyOf: - type: number - type: 'null' title: Directions description: Directions actions (device/os breakdown only) website: anyOf: - type: number - type: 'null' title: Website description: Website actions (device/os breakdown only) moreinfo: anyOf: - type: number - type: 'null' title: Moreinfo description: More info actions (device/os breakdown only) coupon: anyOf: - type: number - type: 'null' title: Coupon description: Coupon actions (device/os breakdown only) video: anyOf: - type: number - type: 'null' title: Video description: Video actions (device/os breakdown only) cumulative_reach: anyOf: - type: number - type: 'null' title: Cumulative Reach description: Cumulative reach (device/os breakdown only) visits: anyOf: - type: number - type: 'null' title: Visits description: Visits (device/os breakdown only) open_hour_visits: anyOf: - type: number - type: 'null' title: Open Hour Visits description: Open hour visits (device/os breakdown only) projected_visits: anyOf: - type: integer - type: 'null' title: Projected Visits description: Projected visits, -1 when negative (device/os only) projected_open_hour_visits: anyOf: - type: integer - type: 'null' title: Projected Open Hour Visits description: Projected open hour visits, -1 when negative (device/os only) type: object required: - account_name - campaign_id - campaign_name - impressions - clicks - spend - ctr title: SupplySystemDistributionCampaignModel description: Supply/system distribution row for a campaign (device, OS, or publisher type — see key query param). SupplySystemDistributionKey: type: integer enum: - 1 - 2 - 3 title: SupplySystemDistributionKey description: Breakdown dimension for supply/system distribution (Rocket key query param). TargetingTactic: oneOf: - const: 0 title: DEFAULT - const: 31 title: WEATHER - const: 32 title: ON_PREMISE - const: 33 title: GEOTARGETING - const: 34 title: NEIGHBORHOOD - const: 35 title: AUDIENCE type: integer enum: - 0 - 31 - 32 - 33 - 34 - 35 title: TargetingTactic x-enum-varnames: - DEFAULT - WEATHER - ON_PREMISE - GEOTARGETING - NEIGHBORHOOD - AUDIENCE TenantModel: properties: id: type: integer title: Id name: type: string title: Name type: $ref: '#/components/schemas/TenantType' tier: type: integer title: Tier is_holding_company: type: boolean title: Is Holding Company payment_type: $ref: '#/components/schemas/PaymentType' created_date: type: string format: date-time title: Created Date updated_date: type: string format: date-time title: Updated Date referrer_url: anyOf: - type: string - type: 'null' title: Referrer Url utm_campaign: anyOf: - type: string - type: 'null' title: Utm Campaign type: object required: - id - name - type - tier - is_holding_company - payment_type - created_date - updated_date - referrer_url - utm_campaign title: TenantModel TenantSearchResult: properties: id: type: integer title: Id name: type: string title: Name type: object required: - id - name title: TenantSearchResult TenantType: oneOf: - const: 0 title: MANAGED - const: 1 title: SELF_SERVE - const: 2 title: CHANNEL type: integer enum: - 0 - 1 - 2 title: TenantType x-enum-varnames: - MANAGED - SELF_SERVE - CHANNEL TextBannerCreativeSettings-Input: properties: caption: type: string maxLength: 160 title: Caption description: Headline text shown on the banner default: '' business_name: anyOf: - type: string maxLength: 128 - type: 'null' title: Business Name description: Business name shown on the banner background_color: anyOf: - type: string pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ examples: - FFAA74 - 01AB23CD - type: 'null' title: Background Color description: Hex color (without leading `#`). Used when no `background_image_url` is provided. background_image_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Background Image Url description: Must be 320x50 or proportional business_logo_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Business Logo Url description: Must be 40x40 or proportional business_name_color: anyOf: - type: string pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ examples: - FFAA74 - 01AB23CD - type: 'null' title: Business Name Color caption_color: anyOf: - type: string pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ examples: - FFAA74 - 01AB23CD - type: 'null' title: Caption Color distance_color: anyOf: - type: string pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ examples: - FFAA74 - 01AB23CD - type: 'null' title: Distance Color show_scrolling_text: type: boolean title: Show Scrolling Text default: false show_distance: type: boolean title: Show Distance default: false type: object title: TextBannerCreativeSettings TextBannerCreativeSettings-Output: properties: caption: type: string maxLength: 160 title: Caption description: Headline text shown on the banner default: '' business_name: anyOf: - type: string maxLength: 128 - type: 'null' title: Business Name description: Business name shown on the banner background_color: anyOf: - type: string pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ examples: - FFAA74 - 01AB23CD - type: 'null' title: Background Color description: Hex color (without leading `#`). Used when no `background_image_url` is provided. background_image_url: anyOf: - type: string - type: 'null' title: Background Image Url description: Must be 320x50 or proportional business_logo_url: anyOf: - type: string - type: 'null' title: Business Logo Url description: Must be 40x40 or proportional business_name_color: anyOf: - type: string pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ examples: - FFAA74 - 01AB23CD - type: 'null' title: Business Name Color caption_color: anyOf: - type: string pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ examples: - FFAA74 - 01AB23CD - type: 'null' title: Caption Color distance_color: anyOf: - type: string pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ examples: - FFAA74 - 01AB23CD - type: 'null' title: Distance Color show_scrolling_text: type: boolean title: Show Scrolling Text default: false show_distance: type: boolean title: Show Distance default: false type: object title: TextBannerCreativeSettings ThirdPartyAudienceStatus: oneOf: - const: Ready title: READY - const: Building title: BUILDING - const: Available title: AVAILABLE type: string enum: - Ready - Building - Available title: ThirdPartyAudienceStatus x-enum-varnames: - READY - BUILDING - AVAILABLE TimeseriesDowAdgroupModel: properties: day: type: string title: Day description: Day of week label (e.g. mon, tue) adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group display name imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected visits sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate web: anyOf: - type: number - type: 'null' title: Web description: Website secondary actions dir: anyOf: - type: number - type: 'null' title: Dir description: Directions secondary actions ctc: anyOf: - type: number - type: 'null' title: Ctc description: Click-to-call secondary actions info: anyOf: - type: number - type: 'null' title: Info description: More info secondary actions cpn: anyOf: - type: number - type: 'null' title: Cpn description: Coupon secondary actions vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate video_start: anyOf: - type: number - type: 'null' title: Video Start description: Video start video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile description: Video first quartile video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint description: Video midpoint video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile description: Video third quartile video_end: anyOf: - type: number - type: 'null' title: Video End description: Video end type: object required: - day title: TimeseriesDowAdgroupModel description: Aggregated metrics by day of week for an ad group timeseries chart. TimeseriesDowCampaignAdgroupsModel: properties: day: $ref: '#/components/schemas/TimeseriesDowDayLabel' description: Day of week (mon through sun) adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group display name imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected visits sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate web: anyOf: - type: number - type: 'null' title: Web description: Website secondary actions dir: anyOf: - type: number - type: 'null' title: Dir description: Directions secondary actions ctc: anyOf: - type: number - type: 'null' title: Ctc description: Click-to-call secondary actions info: anyOf: - type: number - type: 'null' title: Info description: More info secondary actions cpn: anyOf: - type: number - type: 'null' title: Cpn description: Coupon secondary actions vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate video_start: anyOf: - type: number - type: 'null' title: Video Start description: Video start video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile description: Video first quartile video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint description: Video midpoint video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile description: Video third quartile video_end: anyOf: - type: number - type: 'null' title: Video End description: Video end type: object required: - day - adgroup_id - adgroup_name title: TimeseriesDowCampaignAdgroupsModel description: Day-of-week timeseries metrics per ad group within a campaign. TimeseriesDowCampaignCreativesModel: properties: day: $ref: '#/components/schemas/TimeseriesDowDayLabel' description: Day of week (mon through sun) creative_id: type: integer title: Creative Id description: Creative ID creative_name: type: string title: Creative Name description: Creative display name imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected visits sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate web: anyOf: - type: number - type: 'null' title: Web description: Website secondary actions dir: anyOf: - type: number - type: 'null' title: Dir description: Directions secondary actions ctc: anyOf: - type: number - type: 'null' title: Ctc description: Click-to-call secondary actions info: anyOf: - type: number - type: 'null' title: Info description: More info secondary actions cpn: anyOf: - type: number - type: 'null' title: Cpn description: Coupon secondary actions vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate video_start: anyOf: - type: number - type: 'null' title: Video Start description: Video start video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile description: Video first quartile video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint description: Video midpoint video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile description: Video third quartile video_end: anyOf: - type: number - type: 'null' title: Video End description: Video end type: object required: - day - creative_id - creative_name title: TimeseriesDowCampaignCreativesModel description: Day-of-week timeseries metrics per creative within a campaign. TimeseriesDowCampaignModel: properties: day: type: string title: Day campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id description: Campaign ID campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name description: Campaign display name imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected visits sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate web: anyOf: - type: number - type: 'null' title: Web dir: anyOf: - type: number - type: 'null' title: Dir ctc: anyOf: - type: number - type: 'null' title: Ctc info: anyOf: - type: number - type: 'null' title: Info cpn: anyOf: - type: number - type: 'null' title: Cpn vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate video_start: anyOf: - type: number - type: 'null' title: Video Start description: Video start video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile description: Video first quartile video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint description: Video midpoint video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile description: Video third quartile video_end: anyOf: - type: number - type: 'null' title: Video End description: Video end type: object required: - day title: TimeseriesDowCampaignModel TimeseriesDowCreativeModel: properties: day: type: string title: Day description: Day of week label (e.g. mon, tue) creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative display name imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected visits sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate web: anyOf: - type: number - type: 'null' title: Web dir: anyOf: - type: number - type: 'null' title: Dir ctc: anyOf: - type: number - type: 'null' title: Ctc info: anyOf: - type: number - type: 'null' title: Info cpn: anyOf: - type: number - type: 'null' title: Cpn vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate video_start: anyOf: - type: number - type: 'null' title: Video Start description: Video start video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile description: Video first quartile video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint description: Video midpoint video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile description: Video third quartile video_end: anyOf: - type: number - type: 'null' title: Video End description: Video end type: object required: - day title: TimeseriesDowCreativeModel description: Day-of-week timeseries for a single creative (chart or full aggregation). TimeseriesDowDataType: oneOf: - const: chart title: CHART description: Returned shape for standalone timeseries DOW routes (campaign, ad group, creative). - const: full title: FULL description: Returned shape for standalone timeseries DOW routes (campaign, ad group, creative). type: string enum: - chart - full title: TimeseriesDowDataType description: Returned shape for standalone timeseries DOW routes (campaign, ad group, creative). x-enum-varnames: - CHART - FULL TimeseriesDowDayLabel: oneOf: - const: mon title: MON description: Lowercase day-of-week labels returned by timeseries DOW queries. - const: tue title: TUE description: Lowercase day-of-week labels returned by timeseries DOW queries. - const: wed title: WED description: Lowercase day-of-week labels returned by timeseries DOW queries. - const: thu title: THU description: Lowercase day-of-week labels returned by timeseries DOW queries. - const: fri title: FRI description: Lowercase day-of-week labels returned by timeseries DOW queries. - const: sat title: SAT description: Lowercase day-of-week labels returned by timeseries DOW queries. - const: sun title: SUN description: Lowercase day-of-week labels returned by timeseries DOW queries. type: string enum: - mon - tue - wed - thu - fri - sat - sun title: TimeseriesDowDayLabel description: Lowercase day-of-week labels returned by timeseries DOW queries. x-enum-varnames: - MON - TUE - WED - THU - FRI - SAT - SUN TimeseriesDowTodAdgroupModel: properties: day_type: type: string title: Day Type description: Day type (wkd for weekday, wke for weekend) day: type: string title: Day description: Day of week label (e.g. mon, tue) hr: type: integer title: Hr description: Hour of day (0-23) imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions web: anyOf: - type: number - type: 'null' title: Web description: Website secondary actions dir: anyOf: - type: number - type: 'null' title: Dir description: Directions secondary actions ctc: anyOf: - type: number - type: 'null' title: Ctc description: Click-to-call secondary actions info: anyOf: - type: number - type: 'null' title: Info description: More info secondary actions cpn: anyOf: - type: number - type: 'null' title: Cpn description: Coupon secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected visits, -1 when negative sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate video_start: anyOf: - type: number - type: 'null' title: Video Start description: Video starts (returned when data_type=full) video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile description: Video first quartile completions (returned when data_type=full) video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint description: Video midpoint completions (returned when data_type=full) video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile description: Video third quartile completions (returned when data_type=full) video_end: anyOf: - type: number - type: 'null' title: Video End description: Video completions (returned when data_type=full) type: object required: - day_type - day - hr title: TimeseriesDowTodAdgroupModel description: Aggregated metrics by day of week and time of day for an ad group timeseries. TimeseriesDowTodCampaignAdgroupsModel: properties: day_type: type: string title: Day Type description: Day type (wkd for weekday, wke for weekend) day: type: string title: Day description: Day of week label (e.g. mon, tue) hr: type: integer title: Hr description: Hour of day (0-23) adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group display name imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions web: anyOf: - type: number - type: 'null' title: Web description: Website secondary actions dir: anyOf: - type: number - type: 'null' title: Dir description: Directions secondary actions ctc: anyOf: - type: number - type: 'null' title: Ctc description: Click-to-call secondary actions info: anyOf: - type: number - type: 'null' title: Info description: More info secondary actions cpn: anyOf: - type: number - type: 'null' title: Cpn description: Coupon secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected visits, -1 when negative sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate video_start: anyOf: - type: number - type: 'null' title: Video Start description: Video starts video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile description: Video first quartile completions video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint description: Video midpoint completions video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile description: Video third quartile completions video_end: anyOf: - type: number - type: 'null' title: Video End description: Video completions type: object required: - day_type - day - hr - adgroup_id - adgroup_name title: TimeseriesDowTodCampaignAdgroupsModel description: Day-of-week and time-of-day timeseries metrics per ad group within a campaign. TimeseriesDowTodCampaignCreativesModel: properties: day_type: type: string title: Day Type description: Day type (wkd for weekday, wke for weekend) day: type: string title: Day description: Day of week label (e.g. mon, tue) hr: type: integer title: Hr description: Hour of day (0-23) creative_id: type: integer title: Creative Id description: Creative ID creative_name: type: string title: Creative Name description: Creative display name imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions web: anyOf: - type: number - type: 'null' title: Web description: Website secondary actions dir: anyOf: - type: number - type: 'null' title: Dir description: Directions secondary actions ctc: anyOf: - type: number - type: 'null' title: Ctc description: Click-to-call secondary actions info: anyOf: - type: number - type: 'null' title: Info description: More info secondary actions cpn: anyOf: - type: number - type: 'null' title: Cpn description: Coupon secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected visits, -1 when negative sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate video_start: anyOf: - type: number - type: 'null' title: Video Start description: Video starts video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile description: Video first quartile completions video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint description: Video midpoint completions video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile description: Video third quartile completions video_end: anyOf: - type: number - type: 'null' title: Video End description: Video completions type: object required: - day_type - day - hr - creative_id - creative_name title: TimeseriesDowTodCampaignCreativesModel description: Day-of-week and time-of-day timeseries metrics per creative within a campaign. TimeseriesDowTodCampaignModel: properties: day_type: type: string title: Day Type description: Day type (wkd for weekday, wke for weekend) day: type: string title: Day description: Day of week label (e.g. mon, tue) hr: type: integer title: Hr description: Hour of day (0-23) imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions web: anyOf: - type: number - type: 'null' title: Web description: Website secondary actions dir: anyOf: - type: number - type: 'null' title: Dir description: Directions secondary actions ctc: anyOf: - type: number - type: 'null' title: Ctc description: Click-to-call secondary actions info: anyOf: - type: number - type: 'null' title: Info description: More info secondary actions cpn: anyOf: - type: number - type: 'null' title: Cpn description: Coupon secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected visits, -1 when negative sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate video_start: anyOf: - type: number - type: 'null' title: Video Start description: Video starts (returned when data_type=full) video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile description: Video first quartile completions (returned when data_type=full) video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint description: Video midpoint completions (returned when data_type=full) video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile description: Video third quartile completions (returned when data_type=full) video_end: anyOf: - type: number - type: 'null' title: Video End description: Video completions (returned when data_type=full) type: object required: - day_type - day - hr title: TimeseriesDowTodCampaignModel description: Aggregated metrics by day of week and time of day for a campaign timeseries. TimeseriesDowTodCreativeModel: properties: day_type: type: string title: Day Type description: Day type (wkd for weekday, wke for weekend) day: type: string title: Day description: Day of week label (e.g. mon, tue) hr: type: integer title: Hr description: Hour of day (0-23) creative_id: type: integer title: Creative Id description: Creative ID creative_name: type: string title: Creative Name description: Creative name imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions web: anyOf: - type: number - type: 'null' title: Web description: Website secondary actions dir: anyOf: - type: number - type: 'null' title: Dir description: Directions secondary actions ctc: anyOf: - type: number - type: 'null' title: Ctc description: Click-to-call secondary actions info: anyOf: - type: number - type: 'null' title: Info description: More info secondary actions cpn: anyOf: - type: number - type: 'null' title: Cpn description: Coupon secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits prj_vst: anyOf: - type: number - type: 'null' title: Prj Vst description: Projected visits, -1 when negative sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate video_start: anyOf: - type: number - type: 'null' title: Video Start description: Video starts (returned when data_type=full) video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile description: Video first quartile completions (returned when data_type=full) video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint description: Video midpoint completions (returned when data_type=full) video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile description: Video third quartile completions (returned when data_type=full) video_end: anyOf: - type: number - type: 'null' title: Video End description: Video completions (returned when data_type=full) type: object required: - day_type - day - hr - creative_id - creative_name title: TimeseriesDowTodCreativeModel description: Aggregated metrics by day of week and time of day for a creative timeseries. TimeseriesTodAdgroupModel: properties: hr: type: integer title: Hr description: Hour of day (0–23) adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name imp: type: number title: Imp description: Impressions for this hour bucket clks: type: number title: Clks description: Total clicks spt: type: number title: Spt description: Spend (gross revenue) sa: type: number title: Sa description: Total secondary actions web: type: number title: Web description: Website secondary actions dir: type: number title: Dir description: Directions secondary actions ctc: type: number title: Ctc description: Click-to-call secondary actions info: type: number title: Info description: More info secondary actions cpn: type: number title: Cpn description: Coupon secondary actions vst: type: number title: Vst description: Total visits oh_vst: type: number title: Oh Vst description: Open hour visits prj_vst: type: number title: Prj Vst description: Projected visits (-1 when negative raw value) sar: type: number title: Sar description: Secondary action rate ctr: type: number title: Ctr description: Click-through rate vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate when video starts > 0 video_start: type: number title: Video Start description: Video starts video_first_quartile: type: number title: Video First Quartile description: Video first quartile video_midpoint: type: number title: Video Midpoint description: Video midpoint video_third_quartile: type: number title: Video Third Quartile description: Video third quartile video_end: type: number title: Video End description: Video completes type: object required: - hr - adgroup_id - adgroup_name - imp - clks - spt - sa - web - dir - ctc - info - cpn - vst - oh_vst - prj_vst - sar - ctr - video_start - video_first_quartile - video_midpoint - video_third_quartile - video_end title: TimeseriesTodAdgroupModel description: Time-of-day chart for a single ad group with full metrics TimeseriesTodCampaignAdgroupChartModel: properties: hr: type: integer title: Hr description: Hour of day (0–23) adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - hr title: TimeseriesTodCampaignAdgroupChartModel description: Time-of-day chart row per ad group within a campaign (metrics included per query flags). TimeseriesTodCampaignChartModel: properties: hr: type: integer title: Hr description: Hour of day (0–23) imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - hr title: TimeseriesTodCampaignChartModel description: Time-of-day chart row for a campaign (metrics included per query flags; hr is always returned). TimeseriesTodCampaignCreativesChartModel: properties: hr: type: integer title: Hr description: Hour of day (0–23) creative_id: type: integer title: Creative Id description: Creative ID creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name imp: anyOf: - type: number - type: 'null' title: Imp description: Total impressions clks: anyOf: - type: number - type: 'null' title: Clks description: Total clicks spt: anyOf: - type: number - type: 'null' title: Spt description: Spent sa: anyOf: - type: number - type: 'null' title: Sa description: Total secondary actions vst: anyOf: - type: number - type: 'null' title: Vst description: Total visits oh_vst: anyOf: - type: number - type: 'null' title: Oh Vst description: Total open hour visits sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate type: object required: - hr - creative_id title: TimeseriesTodCampaignCreativesChartModel description: Time-of-day chart row per creative for a campaign (metrics included per query flags). Timezone: oneOf: - const: America/Los_Angeles title: AMERICA_LOS_ANGELES - const: America/Phoenix title: AMERICA_PHOENIX - const: America/Chicago title: AMERICA_CHICAGO - const: America/New_York title: AMERICA_NEW_YORK - const: Pacific/Honolulu title: PACIFIC_HONOLULU - const: America/Anchorage title: AMERICA_ANCHORAGE - const: America/St_Johns title: AMERICA_ST_JOHNS - const: America/Halifax title: AMERICA_HALIFAX - const: America/Blanc-Sablon title: AMERICA_BLANC_SABLON - const: America/Toronto title: AMERICA_TORONTO - const: America/Atikokan title: AMERICA_ATIKOKAN - const: America/Winnipeg title: AMERICA_WINNIPEG - const: America/Resolute title: AMERICA_RESOLUTE - const: America/Regina title: AMERICA_REGINA - const: America/Edmonton title: AMERICA_EDMONTON - const: America/Creston title: AMERICA_CRESTON - const: America/Vancouver title: AMERICA_VANCOUVER type: string enum: - America/Los_Angeles - America/Phoenix - America/Chicago - America/New_York - Pacific/Honolulu - America/Anchorage - America/St_Johns - America/Halifax - America/Blanc-Sablon - America/Toronto - America/Atikokan - America/Winnipeg - America/Resolute - America/Regina - America/Edmonton - America/Creston - America/Vancouver title: Timezone x-enum-varnames: - AMERICA_LOS_ANGELES - AMERICA_PHOENIX - AMERICA_CHICAGO - AMERICA_NEW_YORK - PACIFIC_HONOLULU - AMERICA_ANCHORAGE - AMERICA_ST_JOHNS - AMERICA_HALIFAX - AMERICA_BLANC_SABLON - AMERICA_TORONTO - AMERICA_ATIKOKAN - AMERICA_WINNIPEG - AMERICA_RESOLUTE - AMERICA_REGINA - AMERICA_EDMONTON - AMERICA_CRESTON - AMERICA_VANCOUVER TodMetricsAdgroupModel: properties: tod: type: integer title: Tod description: Hour of day (0–23) from the hourly summary timestamp account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID when all_creatives=true creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name when all_creatives=true impressions: type: number title: Impressions description: Impressions for this hour bucket clicks: type: number title: Clicks description: Clicks for this hour bucket spend: type: number title: Spend description: Spend (gross revenue) for this hour bucket ctr: type: number title: Ctr description: Click-through rate (percentage) type: object required: - tod - account_name - campaign_id - campaign_name - adgroup_id - adgroup_name - impressions - clicks - spend - ctr title: TodMetricsAdgroupModel description: Time-of-day hourly metrics for an ad group (optionally split by creative). TodMetricsCampaignModel: properties: tod: type: integer title: Tod description: Hour of day (0–23) from the hourly summary timestamp account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID when all_adgroups=true adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name when all_adgroups=true creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID, always null for campaign time-of-day metrics creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name, always null for campaign time-of-day metrics impressions: type: number title: Impressions description: Impressions for this hour bucket clicks: type: number title: Clicks description: Clicks for this hour bucket spend: type: number title: Spend description: Spend (gross revenue) for this hour bucket ctr: type: number title: Ctr description: Click-through rate (percentage) type: object required: - tod - account_name - campaign_id - campaign_name - impressions - clicks - spend - ctr title: TodMetricsCampaignModel description: Time-of-day hourly metrics for a campaign, optionally split by ad group. TopImpLocationsAdgroupFieldName: oneOf: - const: address title: ADDRESS description: Location type for top impressed locations (adgroup). - const: biz title: BIZ description: Location type for top impressed locations (adgroup). - const: dma title: DMA description: Location type for top impressed locations (adgroup). - const: poi title: POI description: Location type for top impressed locations (adgroup). - const: state title: STATE description: Location type for top impressed locations (adgroup). - const: zipcode title: ZIPCODE description: Location type for top impressed locations (adgroup). type: string enum: - address - biz - dma - poi - state - zipcode title: TopImpLocationsAdgroupFieldName description: Location type for top impressed locations (adgroup). x-enum-varnames: - ADDRESS - BIZ - DMA - POI - STATE - ZIPCODE TopImpLocationsAdgroupMetricName: oneOf: - const: clicks title: CLICKS description: Metric to sort by for top impressed locations (adgroup). - const: impressions title: IMPRESSIONS description: Metric to sort by for top impressed locations (adgroup). - const: total_sa title: TOTAL_SA description: Metric to sort by for top impressed locations (adgroup). type: string enum: - clicks - impressions - total_sa title: TopImpLocationsAdgroupMetricName description: Metric to sort by for top impressed locations (adgroup). x-enum-varnames: - CLICKS - IMPRESSIONS - TOTAL_SA TopImpLocationsAdgroupModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name address: anyOf: - type: string - type: 'null' title: Address description: Address (address/poi/biz) city: anyOf: - type: string - type: 'null' title: City description: City state: anyOf: - type: string - type: 'null' title: State description: State country: anyOf: - type: string - type: 'null' title: Country description: Country zip: anyOf: - type: string - type: 'null' title: Zip description: Zip code latitude: anyOf: - type: number - type: 'null' title: Latitude description: Latitude longitude: anyOf: - type: number - type: 'null' title: Longitude description: Longitude dma: anyOf: - type: integer - type: 'null' title: Dma description: Designated market area impressions: type: integer title: Impressions description: Impressions clicks: type: integer title: Clicks description: Clicks total_sa: type: integer title: Total Sa description: Total secondary actions xad_gross_revenue: type: number title: Xad Gross Revenue description: Gross revenue (spend) ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate (bounding box only) type: object required: - campaign_id - campaign_name - adgroup_id - adgroup_name - impressions - clicks - total_sa - xad_gross_revenue title: TopImpLocationsAdgroupModel description: Response model for top impressed locations by adgroup. TopImpLocationsCampaignModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name address: anyOf: - type: string - type: 'null' title: Address description: Address (address/poi/biz) city: anyOf: - type: string - type: 'null' title: City description: City state: anyOf: - type: string - type: 'null' title: State description: State country: anyOf: - type: string - type: 'null' title: Country description: Country zip: anyOf: - type: string - type: 'null' title: Zip description: Zip code latitude: anyOf: - type: number - type: 'null' title: Latitude description: Latitude longitude: anyOf: - type: number - type: 'null' title: Longitude description: Longitude dma: anyOf: - type: integer - type: 'null' title: Dma description: Designated market area impressions: type: integer title: Impressions description: Impressions clicks: type: integer title: Clicks description: Clicks total_sa: type: integer title: Total Sa description: Total secondary actions xad_gross_revenue: type: number title: Xad Gross Revenue description: Gross revenue (spend) ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate (bounding box only) type: object required: - campaign_id - campaign_name - impressions - clicks - total_sa - xad_gross_revenue title: TopImpLocationsCampaignModel description: Response model for top impressed locations by campaign. TopLocationsAdgroupModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name state: anyOf: - type: string - type: 'null' title: State description: State code country: anyOf: - type: string - type: 'null' title: Country description: Country code dma: anyOf: - type: integer - type: 'null' title: Dma description: DMA code (US only) zip: anyOf: - type: string - type: 'null' title: Zip description: Zip/postal code city: anyOf: - type: string - type: 'null' title: City description: City name impressions: type: number title: Impressions description: Impressions clicks: type: number title: Clicks description: Clicks ctr: type: number title: Ctr description: Click-through rate secondary_actions: type: number title: Secondary Actions description: Secondary actions spend: type: number title: Spend description: Spend visits: type: number title: Visits description: Store visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate latitude: anyOf: - type: number - type: 'null' title: Latitude description: Latitude (zipcode type) longitude: anyOf: - type: number - type: 'null' title: Longitude description: Longitude (zipcode type) type: object required: - campaign_id - campaign_name - adgroup_id - adgroup_name - impressions - clicks - ctr - secondary_actions - spend - visits title: TopLocationsAdgroupModel description: Response model for top locations (impressions-based) by ad group. TopLocationsCampaignFieldName: oneOf: - const: state title: STATE description: Location type for top locations (impressions-based) campaign endpoint. - const: dma title: DMA description: Location type for top locations (impressions-based) campaign endpoint. - const: zipcode title: ZIPCODE description: Location type for top locations (impressions-based) campaign endpoint. type: string enum: - state - dma - zipcode title: TopLocationsCampaignFieldName description: Location type for top locations (impressions-based) campaign endpoint. x-enum-varnames: - STATE - DMA - ZIPCODE TopLocationsCampaignModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name state: anyOf: - type: string - type: 'null' title: State description: State code country: anyOf: - type: string - type: 'null' title: Country description: Country code dma: anyOf: - type: integer - type: 'null' title: Dma description: DMA code (US only) zip: anyOf: - type: string - type: 'null' title: Zip description: Zip/postal code city: anyOf: - type: string - type: 'null' title: City description: City name impressions: type: number title: Impressions description: Impressions clicks: type: number title: Clicks description: Clicks ctr: type: number title: Ctr description: Click-through rate secondary_actions: type: number title: Secondary Actions description: Secondary actions spend: type: number title: Spend description: Spend visits: type: number title: Visits description: Store visits vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate latitude: anyOf: - type: number - type: 'null' title: Latitude description: Latitude (zipcode type) longitude: anyOf: - type: number - type: 'null' title: Longitude description: Longitude (zipcode type) type: object required: - campaign_id - campaign_name - impressions - clicks - ctr - secondary_actions - spend - visits title: TopLocationsCampaignModel description: Response model for top locations (impressions-based) by campaign. TopLocationsMetricName: oneOf: - const: impressions title: IMPRESSIONS description: Allowed sort_by metric for top locations campaign endpoint. - const: clicks title: CLICKS description: Allowed sort_by metric for top locations campaign endpoint. - const: ctr title: CTR description: Allowed sort_by metric for top locations campaign endpoint. - const: secondary_actions title: SECONDARY_ACTIONS description: Allowed sort_by metric for top locations campaign endpoint. - const: visits title: VISITS description: Allowed sort_by metric for top locations campaign endpoint. type: string enum: - impressions - clicks - ctr - secondary_actions - visits title: TopLocationsMetricName description: Allowed sort_by metric for top locations campaign endpoint. x-enum-varnames: - IMPRESSIONS - CLICKS - CTR - SECONDARY_ACTIONS - VISITS TopSVLocationsAdgroupModel: properties: campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name adgroup_id: type: integer title: Adgroup Id adgroup_name: type: string title: Adgroup Name poi_id: anyOf: - type: string - type: 'null' title: Poi Id company_name: anyOf: - type: string - type: 'null' title: Company Name address: anyOf: - type: string - type: 'null' title: Address zip: anyOf: - type: string - type: 'null' title: Zip city: anyOf: - type: string - type: 'null' title: City state: anyOf: - type: string - type: 'null' title: State country: anyOf: - type: string - type: 'null' title: Country dma: anyOf: - type: integer - type: 'null' title: Dma visits: anyOf: - type: number - type: 'null' title: Visits latitude: anyOf: - type: number - type: 'null' title: Latitude longitude: anyOf: - type: number - type: 'null' title: Longitude total_sv: anyOf: - type: integer - type: 'null' title: Total Sv instore: anyOf: - $ref: '#/components/schemas/POIPolygonModel' - type: 'null' onlot: anyOf: - $ref: '#/components/schemas/POIPolygonModel' - type: 'null' type: object required: - campaign_id - campaign_name - adgroup_id - adgroup_name title: TopSVLocationsAdgroupModel TopSVLocationsCampaignFieldName: oneOf: - const: address title: ADDRESS - const: zipcode title: ZIPCODE - const: state title: STATE - const: dma title: DMA type: string enum: - address - zipcode - state - dma title: TopSVLocationsCampaignFieldName x-enum-varnames: - ADDRESS - ZIPCODE - STATE - DMA TopSVLocationsCampaignModel: properties: campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name poi_id: anyOf: - type: string - type: 'null' title: Poi Id company_name: anyOf: - type: string - type: 'null' title: Company Name address: anyOf: - type: string - type: 'null' title: Address zip: anyOf: - type: string - type: 'null' title: Zip city: anyOf: - type: string - type: 'null' title: City state: anyOf: - type: string - type: 'null' title: State country: anyOf: - type: string - type: 'null' title: Country dma: anyOf: - type: integer - type: 'null' title: Dma visits: anyOf: - type: number - type: 'null' title: Visits latitude: anyOf: - type: number - type: 'null' title: Latitude longitude: anyOf: - type: number - type: 'null' title: Longitude total_sv: anyOf: - type: integer - type: 'null' title: Total Sv instore: anyOf: - $ref: '#/components/schemas/POIPolygonModel' - type: 'null' onlot: anyOf: - $ref: '#/components/schemas/POIPolygonModel' - type: 'null' type: object required: - campaign_id - campaign_name title: TopSVLocationsCampaignModel TotalAttributedVisitsAdgroupModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID adgroup_id: type: integer title: Adgroup Id description: Ad group ID version: anyOf: - type: string - type: 'null' title: Version description: Version adgroup_tav_point_estimate: anyOf: - type: number - type: 'null' title: Adgroup Tav Point Estimate description: TAV point estimate for the ad group adgroup_tav_upper_estimate: anyOf: - type: number - type: 'null' title: Adgroup Tav Upper Estimate description: TAV upper estimate for the ad group adgroup_tav_lower_estimate: anyOf: - type: number - type: 'null' title: Adgroup Tav Lower Estimate description: TAV lower estimate for the ad group type: object required: - campaign_id - adgroup_id title: TotalAttributedVisitsAdgroupModel TotalAttributedVisitsModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID version: anyOf: - type: string - type: 'null' title: Version description: Version tav_point_estimate: anyOf: - type: number - type: 'null' title: Tav Point Estimate description: TAV point estimate tav_upper_estimate: anyOf: - type: number - type: 'null' title: Tav Upper Estimate description: TAV upper estimate tav_lower_estimate: anyOf: - type: number - type: 'null' title: Tav Lower Estimate description: TAV lower estimate type: object required: - campaign_id title: TotalAttributedVisitsModel TotalsCampaignCreativesModel: properties: impressions: type: number title: Impressions creative_type: type: string title: Creative Type banner_image_url: type: string title: Banner Image Url type: object required: - impressions - creative_type - banner_image_url title: TotalsCampaignCreativesModel TotalsCampaignModel: properties: account_name: anyOf: - type: string - type: 'null' title: Account Name campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id campaign_name: anyOf: - type: string - type: 'null' title: Campaign Name campaign_start_date: anyOf: - type: string format: date - type: 'null' title: Campaign Start Date campaign_end_date: anyOf: - type: string format: date - type: 'null' title: Campaign End Date adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name creative_id: anyOf: - type: integer - type: 'null' title: Creative Id creative_name: anyOf: - type: string - type: 'null' title: Creative Name impressions: anyOf: - type: number - type: 'null' title: Impressions clicks: anyOf: - type: number - type: 'null' title: Clicks spend: anyOf: - type: number - type: 'null' title: Spend ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate cpm: anyOf: - type: number - type: 'null' title: Cpm total_sa: anyOf: - type: number - type: 'null' title: Total Sa sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate click_to_call: anyOf: - type: integer - type: 'null' title: Click To Call directions: anyOf: - type: integer - type: 'null' title: Directions website: anyOf: - type: integer - type: 'null' title: Website moreinfo: anyOf: - type: integer - type: 'null' title: Moreinfo coupon: anyOf: - type: integer - type: 'null' title: Coupon video: anyOf: - type: integer - type: 'null' title: Video cumulative_reach: anyOf: - type: number - type: 'null' title: Cumulative Reach visits: anyOf: - type: number - type: 'null' title: Visits open_hour_visits: anyOf: - type: number - type: 'null' title: Open Hour Visits cumulative_visitors: anyOf: - type: number - type: 'null' title: Cumulative Visitors open_hour_cumulative_visitors: anyOf: - type: number - type: 'null' title: Open Hour Cumulative Visitors projected_visits: anyOf: - type: number - type: 'null' title: Projected Visits projected_open_hour_visits: anyOf: - type: number - type: 'null' title: Projected Open Hour Visits sum_of_adgroup_visits: anyOf: - type: number - type: 'null' title: Sum Of Adgroup Visits sum_of_adgroup_open_hour_visits: anyOf: - type: number - type: 'null' title: Sum Of Adgroup Open Hour Visits projected_sum_of_adgroup_visits: anyOf: - type: number - type: 'null' title: Projected Sum Of Adgroup Visits projected_sum_of_adgroup_open_hour_visits: anyOf: - type: number - type: 'null' title: Projected Sum Of Adgroup Open Hour Visits svr: anyOf: - type: number - type: 'null' title: Svr total_conversions: anyOf: - type: number - type: 'null' title: Total Conversions click_conversions: anyOf: - type: number - type: 'null' title: Click Conversions view_conversions: anyOf: - type: number - type: 'null' title: View Conversions video_start: anyOf: - type: number - type: 'null' title: Video Start video_first_quartile: anyOf: - type: number - type: 'null' title: Video First Quartile video_midpoint: anyOf: - type: number - type: 'null' title: Video Midpoint video_third_quartile: anyOf: - type: number - type: 'null' title: Video Third Quartile video_end: anyOf: - type: number - type: 'null' title: Video End total_attributed_visits: anyOf: - type: number - type: 'null' title: Total Attributed Visits tav_point_estimate: anyOf: - type: number - type: 'null' title: Tav Point Estimate tav_upper_estimate: anyOf: - type: number - type: 'null' title: Tav Upper Estimate tav_lower_estimate: anyOf: - type: number - type: 'null' title: Tav Lower Estimate tv_imps: anyOf: - type: number - type: 'null' title: Tv Imps mobile_imps: anyOf: - type: number - type: 'null' title: Mobile Imps desktop_imps: anyOf: - type: number - type: 'null' title: Desktop Imps tablet_imps: anyOf: - type: number - type: 'null' title: Tablet Imps ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate frequency: anyOf: - type: number - type: 'null' title: Frequency campaign_budget: anyOf: - type: number - type: 'null' title: Campaign Budget adgroup_budget: anyOf: - type: number - type: 'null' title: Adgroup Budget cumulative_coview_reach: anyOf: - type: integer - type: 'null' title: Cumulative Coview Reach vr: anyOf: - type: number - type: 'null' title: Vr description: Visit rate (visits / impressions) cpv: anyOf: - type: number - type: 'null' title: Cpv today_spend: anyOf: - type: number - type: 'null' title: Today Spend pacing: anyOf: - type: number - type: 'null' title: Pacing type: object title: TotalsCampaignModel TotalsTenantRequestModel: properties: campaign_ids: items: type: integer type: array maxItems: 10000 minItems: 1 title: Campaign Ids description: List of campaign IDs start_date: anyOf: - type: string format: date - type: 'null' title: Start Date description: Date should be in YYYY-MM-DD end_date: anyOf: - type: string format: date - type: 'null' title: End Date description: Date should be in YYYY-MM-DD type: object required: - campaign_ids title: TotalsTenantRequestModel TotalsTenantResponseModel: properties: campaign_id: anyOf: - type: integer - type: 'null' title: Campaign Id impressions: anyOf: - type: number - type: 'null' title: Impressions description: Impressions clicks: anyOf: - type: number - type: 'null' title: Clicks description: Clicks spend: anyOf: - type: number - type: 'null' title: Spend description: Spend today_spend: anyOf: - type: number - type: 'null' title: Today Spend description: Today's partial-day spend, included in spend ctr: anyOf: - type: number - type: 'null' title: Ctr description: Click-through rate, as a percentage total_sa: anyOf: - type: number - type: 'null' title: Total Sa description: Total secondary actions sar: anyOf: - type: number - type: 'null' title: Sar description: Secondary action rate cumulative_reach: anyOf: - type: number - type: 'null' title: Cumulative Reach description: Cumulative reach visits: anyOf: - type: number - type: 'null' title: Visits description: Visits vr: anyOf: - type: number - type: 'null' title: Vr description: Visit rate (visits / impressions) vcr: anyOf: - type: number - type: 'null' title: Vcr description: Video completion rate, null when nothing was served ltr: anyOf: - type: number - type: 'null' title: Ltr description: Listen-through rate, null when nothing was served total_attributed_visits: anyOf: - type: number - type: 'null' title: Total Attributed Visits description: Total attributed visits tav_point_estimate: anyOf: - type: number - type: 'null' title: Tav Point Estimate description: Total attributed visits point estimate tav_upper_estimate: anyOf: - type: number - type: 'null' title: Tav Upper Estimate description: Total attributed visits upper estimate tav_lower_estimate: anyOf: - type: number - type: 'null' title: Tav Lower Estimate description: Total attributed visits lower estimate total_purchases: anyOf: - type: integer - type: 'null' title: Total Purchases description: Total purchases total_conversions: anyOf: - type: integer - type: 'null' title: Total Conversions description: The total number of desired actions completed (e.g., total purchases, sign-ups, carts, etc.) conversion_rate: anyOf: - type: number - type: 'null' title: Conversion Rate description: Fraction of users that resulted in a conversion sales: anyOf: - type: number - type: 'null' title: Sales description: Total revenue generated from purchases type: object title: TotalsTenantResponseModel description: 'Per-campaign totals for POST /reporting/totals/tenant. The performance metrics mirror GET /reporting/totals/campaign; the purchases/conversions/sales metrics come from the web engagement pixel and are absent for campaigns with no pixel data.' TrackingPixelModel: properties: id: type: integer title: Id name: type: string title: Name hashcode: anyOf: - type: string - type: 'null' title: Hashcode type: object required: - id - name title: TrackingPixelModel UpdateAccountModel: properties: name: type: string maxLength: 128 minLength: 1 title: Name website_domain: type: string maxLength: 512 title: Website Domain timezone: $ref: '#/components/schemas/Timezone' vertical_id: anyOf: - $ref: '#/components/schemas/AccountVertical' - type: 'null' type: object required: - name - website_domain - timezone title: UpdateAccountModel UpdateAdgroupModel: properties: name: type: string maxLength: 256 minLength: 1 title: Name objective: anyOf: - $ref: '#/components/schemas/Objective' - type: 'null' description: Unless you're creating an empty ad group with just a name, objective is required. Changing objective may clear targeting that does not apply to the new selection; the saved adgroup may not match your request payload. tactic: $ref: '#/components/schemas/TargetingTactic' description: 'Currently supported: DEFAULT, GEOTARGETING, ON_PREMISE, AUDIENCE, NEIGHBORHOOD' default: 0 media_types: items: $ref: '#/components/schemas/MediaType' type: array maxItems: 2 uniqueItems: true title: Media Types description: 'Currently supported: desktop, ott, audio-streaming, audio-podcast, ctv, web, app. Changing media types may clear targeting that does not apply to the new selection; the saved adgroup may not match your request payload.' bid_type: $ref: '#/components/schemas/app__api__routes__constants__BidType' default: cpm bid_price: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Bid Price default: '0' budgets: items: $ref: '#/components/schemas/BudgetModel-Input' type: array minItems: 1 title: Budgets description: You must provide at least one budget time period. The budget itself can be 0 though. audiences: anyOf: - items: $ref: '#/components/schemas/CreateUpdateAudienceModel' type: array - type: 'null' title: Audiences lookalike_audience_scale: anyOf: - $ref: '#/components/schemas/LookalikeAudienceScale' - type: 'null' deprecated: true location_filters: anyOf: - items: $ref: '#/components/schemas/LocationFilterModel-Input' type: array - type: 'null' title: Location Filters drive_to_locations: anyOf: - items: $ref: '#/components/schemas/CreateUpdateDriveToLocationModel' type: array - type: 'null' title: Drive To Locations genders: anyOf: - items: $ref: '#/components/schemas/Gender' type: array uniqueItems: true - type: 'null' title: Genders age_ranges: anyOf: - items: $ref: '#/components/schemas/AgeRange' type: array uniqueItems: true - type: 'null' title: Age Ranges enable_alcohol_age: type: boolean title: Enable Alcohol Age default: false enable_privacy_idfas: type: boolean title: Enable Privacy Idfas default: false daily_impression_cap: anyOf: - type: integer exclusiveMinimum: 0.0 - type: 'null' title: Daily Impression Cap integration_reports: anyOf: - items: $ref: '#/components/schemas/IntegrationReport' type: array uniqueItems: true - type: 'null' title: Integration Reports third_party_placement_name: anyOf: - type: string maxLength: 128 minLength: 1 - type: 'null' title: Third Party Placement Name third_party_placement_id: anyOf: - type: string maxLength: 128 minLength: 1 - type: 'null' title: Third Party Placement Id mobile_carriers: anyOf: - items: $ref: '#/components/schemas/MobileCarrierCode' type: array - type: 'null' title: Mobile Carriers income_ranges: anyOf: - items: $ref: '#/components/schemas/IncomeRange' type: array uniqueItems: true - type: 'null' title: Income Ranges communities: anyOf: - items: $ref: '#/components/schemas/Community' type: array uniqueItems: true - type: 'null' title: Communities optimization_strategy: $ref: '#/components/schemas/OptimizationStrategy' default: delivery ctr_threshold: anyOf: - type: number maximum: 0.7 minimum: 0.0 - type: 'null' title: Ctr Threshold description: Use null for system default default: 0 sar_threshold: anyOf: - type: integer maximum: 10.0 minimum: 0.0 - type: 'null' title: Sar Threshold description: Use null for system default default: 0 conversion_threshold: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' title: Conversion Threshold description: Use null for system default default: 0 psvr_threshold: anyOf: - type: number maximum: 0.99 minimum: 0.0 - type: 'null' title: Psvr Threshold description: Use null for system default default: 0 publisher_categories: anyOf: - items: $ref: '#/components/schemas/CreateUpdatePublisherCategoryModel' type: array - type: 'null' title: Publisher Categories description: This is only applicable or mobile and desktop media types streaming_video_content_categories: anyOf: - items: $ref: '#/components/schemas/CreateUpdateStreamingVideoContentCategoryModel' type: array - type: 'null' title: Streaming Video Content Categories description: This only works for CTV and OTT media types ctv_premium_categories: anyOf: - items: $ref: '#/components/schemas/CreateUpdateCTVPremiumCategoryModel' type: array - type: 'null' title: Ctv Premium Categories description: This only works for CTV media type audio_podcast_topics: anyOf: - items: $ref: '#/components/schemas/CreateUpdateAudioPodcastTopicModel' type: array - type: 'null' title: Audio Podcast Topics description: This only works for audio podcast media type audio_streaming_genres: anyOf: - items: $ref: '#/components/schemas/CreateUpdateAudioStreamingGenreModel' type: array - type: 'null' title: Audio Streaming Genres description: This only works for audio streaming media type audio_podcast_ad_positions: anyOf: - items: $ref: '#/components/schemas/AudioPodcastAdPosition' type: array uniqueItems: true - type: 'null' title: Audio Podcast Ad Positions description: This only works for audio podcast media type languages: anyOf: - items: $ref: '#/components/schemas/Language' type: array uniqueItems: true - type: 'null' title: Languages description: This only works for audio podcast and streaming media types operating_systems: anyOf: - items: $ref: '#/components/schemas/OperatingSystem' type: array uniqueItems: true - type: 'null' title: Operating Systems description: This only works for mobile media type dayparting: anyOf: - items: type: integer exclusiveMaximum: 336.0 minimum: 0.0 type: array uniqueItems: true - type: 'null' title: Dayparting description: Each number in the list represents a half hour in a week. 0 is the first half hour (12am - 12:30am) on Sunday. 335 is the last half hour (11:30pm - 12am) on Saturday. on_premise_locations: anyOf: - items: $ref: '#/components/schemas/CreateUpdateOnPremiseLocationModel' type: array - type: 'null' title: On Premise Locations neighborhoods: anyOf: - items: $ref: '#/components/schemas/CreateNeighborhoodModel' type: array - type: 'null' title: Neighborhoods neighborhood_types: anyOf: - items: $ref: '#/components/schemas/NeighborhoodType' type: array uniqueItems: true - type: 'null' title: Neighborhood Types tracking_pixels: anyOf: - items: $ref: '#/components/schemas/CreateUpdateTrackingPixelModel' type: array - type: 'null' title: Tracking Pixels billability_type: $ref: '#/components/schemas/BillabilityType' default: 0 added_cost_cpm: anyOf: - type: number minimum: 0.0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Added Cost Cpm description: Additional CPM added on top of the base bid price default: '0' viewable_percentage: anyOf: - type: integer maximum: 100.0 exclusiveMinimum: 0.0 - type: 'null' title: Viewable Percentage description: Percentage of measurable impressions that must be viewable measurable_percentage: anyOf: - type: integer maximum: 100.0 exclusiveMinimum: 0.0 - type: 'null' title: Measurable Percentage description: Percentage of impressions that must be measurable gross_bid_price: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Gross Bid Price ad_package: anyOf: - $ref: '#/components/schemas/CreateUpdateAdPackageModel' - type: 'null' description: Used to group similar ad groups budget_padding: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Budget Padding default: '0' rotate_creatives_evenly: type: boolean title: Rotate Creatives Evenly default: true pacing_mode: $ref: '#/components/schemas/PacingMode' description: Spend pacing for the ad group. Omitted defaults to standard (DEFAULT) pacing. default: 0 retargeting_segment_name: anyOf: - type: string minLength: 1 - type: 'null' title: Retargeting Segment Name description: Audience name for retargeting segment exchange_publishers: anyOf: - items: $ref: '#/components/schemas/CreatePublisherModel' type: array - type: 'null' title: Exchange Publishers custom_publishers: anyOf: - items: $ref: '#/components/schemas/CreatePublisherModel' type: array - type: 'null' title: Custom Publishers exchange_bid_type: anyOf: - $ref: '#/components/schemas/ExchangeBidType' - type: 'null' exchange_bid_price: anyOf: - anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ gt: 0 - type: 'null' title: Exchange Bid Price status: type: integer enum: - 2 - 1 title: Status type: object required: - name - budgets - status title: UpdateAdgroupModel UpdateCampaignModel: properties: name: type: string maxLength: 256 minLength: 1 title: Name budget: anyOf: - type: number exclusiveMaximum: 1000000.0 exclusiveMinimum: 0.0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Budget budget_padding: anyOf: - type: number exclusiveMaximum: 100000000.0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Budget Padding budget_level: $ref: '#/components/schemas/BudgetLevel' billing_source: $ref: '#/components/schemas/BillingSource' default: 1 is_auto_reconciliation_enabled: anyOf: - type: boolean - type: 'null' title: Is Auto Reconciliation Enabled account_billing_source_id: anyOf: - type: integer - type: 'null' title: Account Billing Source Id impression_frequency_cap: anyOf: - type: integer exclusiveMaximum: 128.0 exclusiveMinimum: 0.0 - type: 'null' title: Impression Frequency Cap impression_frequency_cap_hours: anyOf: - type: integer exclusiveMaximum: 32768.0 exclusiveMinimum: 0.0 - type: 'null' title: Impression Frequency Cap Hours client_io_name: anyOf: - type: string maxLength: 500 minLength: 1 - type: 'null' title: Client Io Name client_io_number: anyOf: - type: string maxLength: 128 minLength: 1 - type: 'null' title: Client Io Number salesforce_number: anyOf: - type: string maxLength: 16 minLength: 1 - type: 'null' title: Salesforce Number is_cbd_enabled: type: boolean title: Is Cbd Enabled default: false is_political_inventory_enabled: type: boolean title: Is Political Inventory Enabled default: false iab_content_category: anyOf: - type: string maxLength: 10 minLength: 1 - type: 'null' title: Iab Content Category account_executives: items: $ref: '#/components/schemas/CreateUpdateCampaignUserModel' type: array title: Account Executives account_managers: items: $ref: '#/components/schemas/CreateUpdateCampaignUserModel' type: array title: Account Managers campaign_managers: items: $ref: '#/components/schemas/CreateUpdateCampaignUserModel' type: array title: Campaign Managers publisher_domains: items: $ref: '#/components/schemas/PublisherDomainModel' type: array title: Publisher Domains app_bundles: items: $ref: '#/components/schemas/AppBundleModel' type: array title: App Bundles enable_brand_safe_publishers: type: boolean title: Enable Brand Safe Publishers default: true type: object required: - name - budget_level title: UpdateCampaignModel UpdateCreativeModel: properties: name: type: string maxLength: 128 minLength: 1 title: Name type: $ref: '#/components/schemas/CreativeType' description: 'Currently supported: IMAGE, AUDIO, SCRIPT, HTML5, VIDEO, TEXT_BANNER' click_through_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Click Through Url status: $ref: '#/components/schemas/CreativeStatus' description: INCOMPLETE status is not available default: 1 image_banner_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Image Banner Url description: Only applies to IMAGE creatives vast_tag_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Vast Tag Url description: Only applies to VIDEO and AUDIO creatives. Either `vast_tag_url` or `video_url` or `audio_url` must be used. video_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Video Url description: This value comes from `cdn_url` in the `POST /upload` response. Only applies to VIDEO creatives. Either `vast_tag_url` or `video_url` must be used. audio_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Audio Url description: Only applies to AUDIO creatives. Either `vast_tag_url` or `audio_url` must be used. script_tag: anyOf: - type: string - type: 'null' title: Script Tag description: Only applies to SCRIPT creatives size: anyOf: - type: string - type: 'null' title: Size description: Only applies to SCRIPT creatives. This is ignored for other types. api_type: $ref: '#/components/schemas/CreativeAPI' description: Only applies to IMAGE and SCRIPT creatives. This is ignored for other types. default: 0 landing_page: anyOf: - oneOf: - $ref: '#/components/schemas/StandardSuperLandingPage-Input' - $ref: '#/components/schemas/ImageLandingPage-Input' discriminator: propertyName: type mapping: '1': '#/components/schemas/StandardSuperLandingPage-Input' '2': '#/components/schemas/StandardSuperLandingPage-Input' '3': '#/components/schemas/ImageLandingPage-Input' - type: 'null' title: Landing Page description: Settings for custom GT landing page third_party_click_tracker_url: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' title: Third Party Click Tracker Url description: This only applies when `landing_page` is provided. start_date: anyOf: - type: string format: date - type: 'null' title: Start Date end_date: anyOf: - type: string format: date - type: 'null' title: End Date freq_cap_duration: anyOf: - type: integer maximum: 126.0 minimum: 1.0 - type: 'null' title: Freq Cap Duration freq_cap_value: anyOf: - type: integer maximum: 32766.0 minimum: 1.0 - type: 'null' title: Freq Cap Value interstitial: type: boolean title: Interstitial default: false rotation_weight: type: integer maximum: 32766.0 minimum: 1.0 title: Rotation Weight default: 1 image_banner_text_overlay: anyOf: - type: string - type: 'null' title: Image Banner Text Overlay description: Only applies to IMAGE creatives image_banner_text_overlay_css: anyOf: - type: string - type: 'null' title: Image Banner Text Overlay Css description: Only applies to IMAGE creatives text_banner: anyOf: - $ref: '#/components/schemas/TextBannerCreativeSettings-Input' - type: 'null' description: Only applies to TEXT_BANNER creatives. Required for that type. html5_url: anyOf: - type: string - type: 'null' title: Html5 Url description: Only applies to HTML5 creatives. And should be a zip file third_party_placement_id: anyOf: - type: string maxLength: 128 - type: 'null' title: Third Party Placement Id external_impression_urls: anyOf: - items: type: string maxLength: 2083 minLength: 1 format: uri type: array - type: 'null' title: External Impression Urls description: Third-party impression tracker URLs. external_script_urls: anyOf: - items: type: string maxLength: 2083 minLength: 1 format: uri type: array - type: 'null' title: External Script Urls description: Third-party script tracker URLs. type: object required: - name - type title: UpdateCreativeModel UpdateTenantModel: properties: name: type: string maxLength: 64 minLength: 1 title: Name type: object required: - name title: UpdateTenantModel UpdateUserModel: properties: first_name: type: string maxLength: 64 minLength: 1 title: First Name last_name: type: string maxLength: 64 minLength: 1 title: Last Name password: anyOf: - type: string - type: 'null' title: Password groups: anyOf: - items: $ref: '#/components/schemas/Group' type: array - type: 'null' title: Groups type: object required: - first_name - last_name title: UpdateUserModel UploadJobType: oneOf: - const: 0 title: LOCATION_FILTER - const: 1 title: CAMPAIGN_BULK_UPLOAD - const: 2 title: CAMPAIGN_SUMMARY - const: 3 title: VIDEO_TRANSCODER - const: 6 title: CREATIVE_BULK_UPLOAD - const: 7 title: HTML5_CREATIVE - const: 8 title: WAYMARK_VIDEO - const: 9 title: CAMPAIGN_BULK_DOWNLOAD - const: 10 title: CAMPAIGN_BULK_UPLOAD_V2 type: integer enum: - 0 - 1 - 2 - 3 - 6 - 7 - 8 - 9 - 10 title: UploadJobType x-enum-varnames: - LOCATION_FILTER - CAMPAIGN_BULK_UPLOAD - CAMPAIGN_SUMMARY - VIDEO_TRANSCODER - CREATIVE_BULK_UPLOAD - HTML5_CREATIVE - WAYMARK_VIDEO - CAMPAIGN_BULK_DOWNLOAD - CAMPAIGN_BULK_UPLOAD_V2 UploadResponseModel: properties: file_path: type: string title: File Path cdn_url: anyOf: - type: string - type: 'null' title: Cdn Url type: object required: - file_path - cdn_url title: UploadResponseModel UploadType: oneOf: - const: 1 title: VIDEO - const: 2 title: AUDIO - const: 3 title: HTML5 - const: 4 title: OTHER type: integer enum: - 1 - 2 - 3 - 4 title: UploadType x-enum-varnames: - VIDEO - AUDIO - HTML5 - OTHER UserModel: properties: user_id: type: integer title: User Id tenant_id: type: integer title: Tenant Id first_name: type: string title: First Name last_name: type: string title: Last Name email: type: string format: email title: Email created_date: anyOf: - type: string format: date-time - type: 'null' title: Created Date updated_date: anyOf: - type: string format: date-time - type: 'null' title: Updated Date groups: items: $ref: '#/components/schemas/Group' type: array title: Groups status: $ref: '#/components/schemas/UserStatus' authorized_apps: items: $ref: '#/components/schemas/AppCode' type: array title: Authorized Apps type: object required: - user_id - tenant_id - first_name - last_name - email - created_date - updated_date - groups - status - authorized_apps title: UserModel example: authorized_apps: - MF - RA created_date: '2024-01-01T00:00:00' email: eb@groundtruth.com first_name: Emmett groups: - 1 - 11 last_name: Brown status: 1 tenant_id: 1 updated_date: '2025-01-01T00:00:00' user_id: 1 UserStatus: oneOf: - const: 0 title: INACTIVE - const: 1 title: ACTIVE - const: 2 title: NEEDS_ACTIVATION type: integer enum: - 0 - 1 - 2 title: UserStatus x-enum-varnames: - INACTIVE - ACTIVE - NEEDS_ACTIVATION UserinsightVisitModel: properties: key: type: integer title: Key description: 'Membership type: 1=brand, 2=category, 3=behavioral audience' total_visitors: items: type: string type: array title: Total Visitors description: Array of "label count" strings per segment percent_visitors: items: type: string type: array title: Percent Visitors description: Array of "label percent" strings per segment type: object required: - key title: UserinsightVisitModel description: 'Visit membership breakdown: key=1 brand, key=2 category, key=3 behavioral audience.' UsersModel: properties: items: items: $ref: '#/components/schemas/UserModel' type: array title: Items type: object required: - items title: UsersModel ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError VersionModel: properties: version: type: string title: Version type: object required: - version title: VersionModel VisitMembershipBreakdownAdgroupModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: type: integer title: Adgroup Id description: Ad group ID adgroup_name: type: string title: Adgroup Name description: Ad group name key: type: integer title: Key description: 'Membership type: 1=brand, 2=category, 3=behaviour' total_visitors: items: type: string type: array title: Total Visitors description: Array of "label count" strings for visitors per segment percent_visitors: items: type: string type: array title: Percent Visitors description: Array of "label percent" strings for share of visitors per segment type: object required: - account_name - campaign_id - campaign_name - adgroup_id - adgroup_name - key - total_visitors - percent_visitors title: VisitMembershipBreakdownAdgroupModel description: Response model for adgroup-level visit membership breakdown (user insight). VisitMembershipBreakdownCampaignModel: properties: account_name: type: string title: Account Name description: Account name campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name key: type: integer title: Key description: 'Membership type: 1=brand, 2=category, 3=behaviour' total_visitors: items: type: string type: array title: Total Visitors description: Array of "label count" strings for visitors per segment percent_visitors: items: type: string type: array title: Percent Visitors description: Array of "label percent" strings for share of visitors per segment type: object required: - account_name - campaign_id - campaign_name - key - total_visitors - percent_visitors title: VisitMembershipBreakdownCampaignModel description: Response model for campaign-level visit membership breakdown (user insight). VisitMembershipBreakdownKey: type: integer enum: - 1 - 2 - 3 title: VisitMembershipBreakdownKey description: 'Membership type for visit membership breakdown (user insight): brand, category, or behaviour.' VisitationLagWindowModel: properties: account_name: type: string title: Account Name campaign_id: type: integer title: Campaign Id campaign_name: type: string title: Campaign Name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name creative_id: anyOf: - type: integer - type: 'null' title: Creative Id creative_name: anyOf: - type: string - type: 'null' title: Creative Name lag_bucket_id: type: integer title: Lag Bucket Id lag_bucket: type: string title: Lag Bucket visits_after_imp: type: number title: Visits After Imp visits_after_click: type: number title: Visits After Click type: object required: - account_name - campaign_id - campaign_name - lag_bucket_id - lag_bucket - visits_after_imp - visits_after_click title: VisitationLagWindowModel VisitationSVLCampaignModel: properties: date: type: string title: Date description: Metric date in YYYY-MM-DD campaign_id: type: integer title: Campaign Id description: Campaign ID campaign_name: type: string title: Campaign Name description: Campaign name adgroup_id: anyOf: - type: integer - type: 'null' title: Adgroup Id description: Ad group ID when all_adgroups or all_creatives is true adgroup_name: anyOf: - type: string - type: 'null' title: Adgroup Name description: Ad group name when all_adgroups or all_creatives is true creative_id: anyOf: - type: integer - type: 'null' title: Creative Id description: Creative ID when all_creatives is true creative_name: anyOf: - type: string - type: 'null' title: Creative Name description: Creative name when all_creatives is true svl: type: number title: Svl description: Store visitation lift type: object required: - date - campaign_id - campaign_name - svl title: VisitationSVLCampaignModel description: Store visitation lift rows for a campaign, optionally broken out by adgroup or creative. WebEngagementAdgroupResponseModel: properties: date: type: string format: date title: Date description: Report date adgroup_id: type: integer title: Adgroup Id description: Ad group ID pageviews: type: integer title: Pageviews description: The total number of times pages on the site were viewed. Includes repeat views by the same user. sessions: type: integer title: Sessions description: The number of distinct sessions on the site (a session is a continuous period of activity by a user). unique_users: type: integer title: Unique Users description: The number of distinct visitors to the site (based on unique identifier - user_id). avg_time_on_site: type: string title: Avg Time On Site description: The average time spent on the site by visitors during their session. sign_ups: type: integer title: Sign Ups description: Sign-ups carts: type: integer title: Carts description: The number of times items were added to a shopping cart. cart_value: type: number title: Cart Value description: Cart value total_purchases: type: integer title: Total Purchases description: Total purchases checkouts: type: integer title: Checkouts description: The number of times a checkout process was initiated sales: type: number title: Sales description: Total revenue generated from purchases total_conversions: type: integer title: Total Conversions description: The total number of desired actions completed (e.g., total purchases, sign-ups, carts, etc.) conversion_rate: type: number title: Conversion Rate description: Fraction (0-1) of users that resulted in a conversion type: object required: - date - adgroup_id - pageviews - sessions - unique_users - avg_time_on_site - sign_ups - carts - cart_value - total_purchases - checkouts - sales - total_conversions - conversion_rate title: WebEngagementAdgroupResponseModel WebEngagementCampaignResponseModel: properties: date: type: string format: date title: Date description: Report date campaign_id: type: integer title: Campaign Id description: Campaign ID (order_id) pageviews: type: integer title: Pageviews description: The total number of times pages on the site were viewed. Includes repeat views by the same user. sessions: type: integer title: Sessions description: The number of distinct sessions on the site (a session is a continuous period of activity by a user). unique_users: type: integer title: Unique Users description: The number of distinct visitors to the site (based on unique identifier - user_id). avg_time_on_site: type: string title: Avg Time On Site description: The average time spent on the site by visitors during their session. sign_ups: type: integer title: Sign Ups description: Sign-ups carts: type: integer title: Carts description: The number of times items were added to a shopping cart. cart_value: type: number title: Cart Value description: Cart value total_purchases: type: integer title: Total Purchases description: Total purchases checkouts: type: integer title: Checkouts description: The number of times a checkout process was initiated sales: type: number title: Sales description: Total revenue generated from purchases total_conversions: type: integer title: Total Conversions description: The total number of desired actions completed (e.g., total purchases, sign-ups, carts, etc.) conversion_rate: type: number title: Conversion Rate description: Fraction (0-1) of users that resulted in a conversion type: object required: - date - campaign_id - pageviews - sessions - unique_users - avg_time_on_site - sign_ups - carts - cart_value - total_purchases - checkouts - sales - total_conversions - conversion_rate title: WebEngagementCampaignResponseModel WebEngagementTotalsAdgroupResponseModel: properties: adgroup_id: type: integer title: Adgroup Id description: Ad group ID pageviews: type: integer title: Pageviews description: The total number of times pages on the site were viewed. Includes repeat views by the same user. sessions: type: integer title: Sessions description: The number of distinct sessions on the site (a session is a continuous period of activity by a user). unique_users: type: integer title: Unique Users description: The number of distinct visitors to the site (based on unique identifier - user_id). avg_time_on_site: type: string title: Avg Time On Site description: The average time spent on the site by visitors during their session. sign_ups: type: integer title: Sign Ups description: Sign-ups carts: type: integer title: Carts description: The number of times items were added to a shopping cart. cart_value: type: number title: Cart Value description: Cart value total_purchases: type: integer title: Total Purchases description: Total purchases checkouts: type: integer title: Checkouts description: The number of times a checkout process was initiated sales: type: number title: Sales description: Total revenue generated from purchases total_conversions: type: integer title: Total Conversions description: The total number of desired actions completed (e.g., total purchases, sign-ups, carts, etc.) conversion_rate: type: number title: Conversion Rate description: Fraction (0-1) of users that resulted in a conversion type: object required: - adgroup_id - pageviews - sessions - unique_users - avg_time_on_site - sign_ups - carts - cart_value - total_purchases - checkouts - sales - total_conversions - conversion_rate title: WebEngagementTotalsAdgroupResponseModel WebEngagementTotalsCampaignResponseModel: properties: campaign_id: type: integer title: Campaign Id description: Campaign ID (order_id) pageviews: type: integer title: Pageviews description: The total number of times pages on the site were viewed. Includes repeat views by the same user. sessions: type: integer title: Sessions description: The number of distinct sessions on the site (a session is a continuous period of activity by a user). unique_users: type: integer title: Unique Users description: The number of distinct visitors to the site (based on unique identifier - user_id). avg_time_on_site: type: string title: Avg Time On Site description: The average time spent on the site by visitors during their session. sign_ups: type: integer title: Sign Ups description: Sign-ups carts: type: integer title: Carts description: The number of times items were added to a shopping cart. cart_value: type: number title: Cart Value description: Cart value total_purchases: type: integer title: Total Purchases description: Total purchases checkouts: type: integer title: Checkouts description: The number of times a checkout process was initiated sales: type: number title: Sales description: Total revenue generated from purchases total_conversions: type: integer title: Total Conversions description: The total number of desired actions completed (e.g., total purchases, sign-ups, carts, etc.) conversion_rate: type: number title: Conversion Rate description: Fraction (0-1) of users that resulted in a conversion type: object required: - campaign_id - pageviews - sessions - unique_users - avg_time_on_site - sign_ups - carts - cart_value - total_purchases - checkouts - sales - total_conversions - conversion_rate title: WebEngagementTotalsCampaignResponseModel app__api__models__LocationGroupMetadata: properties: type: anyOf: - $ref: '#/components/schemas/LocationGroupType' - type: 'null' url: anyOf: - type: string - type: 'null' title: Url accepted: type: integer title: Accepted default: 0 rejected: type: integer title: Rejected default: 0 invalid: type: integer title: Invalid default: 0 conflict: type: integer title: Conflict default: 0 build_status: anyOf: - $ref: '#/components/schemas/LocationGroupBuildStatus' - type: 'null' description: Audience or neighborhood build pipeline state. If the API is unrelated to audiences and neighborhoods (e.g. /search/drive_to_locations), this will be null. is_sensitive: type: boolean title: Is Sensitive description: True if any of the POIs in the location group are deemed sensitive. default: false type: object title: LocationGroupMetadata app__api__routes__adgroups__constants__AudienceType: oneOf: - const: behavior title: BEHAVIOR - const: custom_audience title: CUSTOM_AUDIENCE - const: segment title: SEGMENT - const: brand title: BRAND - const: category title: CATEGORY - const: location_group title: LOCATION_GROUP - const: third_party title: THIRD_PARTY type: string enum: - behavior - custom_audience - segment - brand - category - location_group - third_party title: AudienceType x-enum-varnames: - BEHAVIOR - CUSTOM_AUDIENCE - SEGMENT - BRAND - CATEGORY - LOCATION_GROUP - THIRD_PARTY app__api__routes__adgroups__models__AudioPodcastTopicModel: properties: id: type: integer title: Id name: type: string title: Name type: object required: - id - name title: AudioPodcastTopicModel app__api__routes__adgroups__models__AudioStreamingGenreModel: properties: id: type: integer title: Id name: type: string title: Name type: object required: - id - name title: AudioStreamingGenreModel app__api__routes__adgroups__models__CTVPremiumCategoryModel: properties: id: type: integer title: Id name: type: string title: Name type: object required: - id - name title: CTVPremiumCategoryModel app__api__routes__adgroups__models__PublisherCategoryModel: properties: id: type: integer title: Id name: type: string title: Name type: object required: - id - name title: PublisherCategoryModel app__api__routes__adgroups__models__PublisherModel: properties: id: type: integer title: Id name: type: string title: Name type: object required: - id - name title: PublisherModel app__api__routes__adgroups__models__StreamingVideoContentCategoryModel: properties: id: type: integer title: Id name: type: string title: Name type: object required: - id - name title: StreamingVideoContentCategoryModel app__api__routes__constants__BidType: oneOf: - const: cpm title: CPM - const: cpc title: CPC - const: cpv title: CPV type: string enum: - cpm - cpc - cpv title: BidType x-enum-varnames: - CPM - CPC - CPV app__api__routes__static__models__AudioPodcastTopicModel: properties: id: type: integer title: Id name: type: string title: Name icon: type: string title: Icon color: type: string pattern: ^[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$ title: Color examples: - FFAA74 - 01AB23CD type: object required: - id - name - icon - color title: AudioPodcastTopicModel app__api__routes__static__models__AudioStreamingGenreModel: properties: id: type: integer title: Id name: type: string title: Name icon: type: string title: Icon type: object required: - id - name - icon title: AudioStreamingGenreModel app__api__routes__static__models__CTVPremiumCategoryModel: properties: id: type: integer title: Id name: type: string title: Name apps: items: $ref: '#/components/schemas/CTVAppModel' type: array title: Apps type: object required: - id - name - apps title: CTVPremiumCategoryModel app__api__routes__static__models__PublisherCategoryModel: properties: id: type: integer title: Id name: type: string title: Name icon: type: string title: Icon type: object required: - id - name - icon title: PublisherCategoryModel app__api__routes__static__models__PublisherModel: properties: id: type: integer title: Id name: type: string title: Name tier: $ref: '#/components/schemas/PublisherTier' type: object required: - id - name - tier title: PublisherModel app__api__routes__static__models__StreamingVideoContentCategoryModel: properties: id: type: integer title: Id name: type: string title: Name icon: type: string title: Icon type: object required: - id - name - icon title: StreamingVideoContentCategoryModel app__constants__BidType: oneOf: - const: CPM title: CPM - const: CPV title: CPV type: string enum: - CPM - CPV title: BidType x-enum-varnames: - CPM - CPV app__services__audience__types__AudienceType: properties: name: type: string title: Name categories: items: $ref: '#/components/schemas/DetailedAudienceCategory' type: array title: Categories type: object required: - name - categories title: AudienceType app__services__audience__types__LocationGroupMetadata: properties: type: anyOf: - $ref: '#/components/schemas/LocationGroupType' - type: 'null' url: anyOf: - type: string - type: 'null' title: Url accepted: type: integer title: Accepted rejected: type: integer title: Rejected invalid: type: integer title: Invalid conflict: type: integer title: Conflict build_status: $ref: '#/components/schemas/LocationGroupBuildStatus' is_sensitive: type: boolean title: Is Sensitive type: object required: - type - url - accepted - rejected - invalid - conflict - build_status - is_sensitive title: LocationGroupMetadata securitySchemes: api-key: type: apiKey in: header name: x-gt-api-key user-id: type: apiKey in: header name: x-gt-user-id tags: - name: Accounts - name: Ad Groups - name: Audiences - name: Campaigns - name: Creative Assets - name: Creatives - name: Direct Mail - name: Health - name: Jobs - name: Miscellaneous - name: Organizations - name: Reporting - name: Search - name: Static - name: Tenants - name: Upload - name: Users servers: - url: https://api-public.groundtruth.com description: Production