openapi: 3.2.0 info: title: Ads Manager Reporting API description: Ads Manager API version: 1.0.0 servers: - url: https://api-public.groundtruth.com description: Production tags: - name: Reporting paths: /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 components: schemas: 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. 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 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). 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 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. 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 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. 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). 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 DowTodDataType: oneOf: - const: chart title: CHART - const: full title: FULL type: string enum: - chart - full title: DowTodDataType x-enum-varnames: - CHART - FULL 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. 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 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 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 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. 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 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 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). 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). 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 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). DoohPublisherCampaignSortByFieldName: oneOf: - const: imp title: IMP - const: publisher title: PUBLISHER type: string enum: - imp - publisher title: DoohPublisherCampaignSortByFieldName x-enum-varnames: - IMP - PUBLISHER 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 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 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 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 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 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 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 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. 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 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.' 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). 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 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. 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 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). 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 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 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 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). 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 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. 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 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. 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). 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). 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 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 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 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 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 AudioPodcastFieldName: oneOf: - const: imp title: IMP - const: ltr title: LTR type: string enum: - imp - ltr title: AudioPodcastFieldName x-enum-varnames: - IMP - LTR 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). 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 SupplySystemDistributionKey: type: integer enum: - 1 - 2 - 3 title: SupplySystemDistributionKey description: Breakdown dimension for supply/system distribution (Rocket key query param). 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. 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 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. 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 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. 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 ErrorResponseModel: properties: errors: items: $ref: '#/components/schemas/ErrorModel' type: array title: Errors type: object required: - errors title: ErrorResponseModel 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 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 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 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 PerformanceDistributionKey: type: integer enum: - 1 - 2 title: PerformanceDistributionKey description: Breakdown dimension for performance distribution (Rocket key query param). 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 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 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 RecommendationsModel: properties: recommendations: items: $ref: '#/components/schemas/RecommendationModel' type: array title: Recommendations type: object required: - recommendations title: RecommendationsModel 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 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 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 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). 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 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 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 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 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 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 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 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). 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. 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 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. VisitMembershipBreakdownKey: type: integer enum: - 1 - 2 - 3 title: VisitMembershipBreakdownKey description: 'Membership type for visit membership breakdown (user insight): brand, category, or behaviour.' 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 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 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 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. 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. 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 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 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 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. 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 BestStrategiesModel: properties: name: type: string title: Name val: type: number title: Val type: object required: - name - val title: BestStrategiesModel 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 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 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 DoohVenueTypeCampaignSortByFieldName: oneOf: - const: imp title: IMP type: string enum: - imp title: DoohVenueTypeCampaignSortByFieldName x-enum-varnames: - IMP 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 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 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. 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 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 MobileCategoryFieldName: oneOf: - const: imp title: IMP - const: ctr title: CTR type: string enum: - imp - ctr title: MobileCategoryFieldName x-enum-varnames: - IMP - CTR 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. 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.' 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). 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 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 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 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 AudienceBreakdownV1Key: type: integer enum: - 1 - 2 title: AudienceBreakdownV1Key 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. 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. 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 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 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 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 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 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. 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 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 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 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}. 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 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 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 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 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 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 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 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 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). 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 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 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 GetDailyMetricsCreativeResponseModel: properties: daily_metrics: items: $ref: '#/components/schemas/DailyMetricsCreativeModel' type: array title: Daily Metrics type: object required: - daily_metrics title: GetDailyMetricsCreativeResponseModel 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 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 BlueprintsPolygonTypes: oneOf: - const: MultiPolygon title: MULTIPOLYGON - const: Polygon title: POLYGON type: string enum: - MultiPolygon - Polygon title: BlueprintsPolygonTypes x-enum-varnames: - MULTIPOLYGON - POLYGON 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 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 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 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. 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 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 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. 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). 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 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 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 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). 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 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 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 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). 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 SuccessResponseModel: properties: success: type: boolean title: Success default: true type: object title: SuccessResponseModel 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 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. 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. 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). 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 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 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 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. 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. 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 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 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 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 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. 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 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 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. 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 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 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 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 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. securitySchemes: api-key: type: apiKey in: header name: x-gt-api-key user-id: type: apiKey in: header name: x-gt-user-id