openapi: 3.2.0 info: title: Outbrain Amplify Performance Reporting API version: '0.1' description: "This API describes the interfaces for interacting with the Outbrain Amplify product. More information about Amplify can be found on our website: http://www.outbrain.com/amplify.\n\nAt this time we are working with a select number of partners to integrate the Amplify API. To be considered for the Amplify API private beta please register for the beta plan.\n\nIf you have any questions, issues, feature requests as well as if you're interested in announcments of new features, please join our Google group:\n\nhttps://groups.google.com/forum/#!forum/outbrain-amplifyapi\n\nAPI Url\nThe base url for all API end-points is https://api.outbrain.com/amplify/v0.1/\n\nTroubleshooting\nIf you're experiencing any issues or any other difficulties, please post a new topic in our Google group: https://groups.google.com/forum/#!forum/outbrain-amplifyapi\n\nPlease attach to your post the AMPLIFY-REQUEST-ID header from the returned response.\nThis header allows us to identify your unique request and helps us to reply quicker and more efficiently.\n\nUpdates\nAug 13, 2026\nNew: Brand Logo\n\nYou can now read and set a brand logo via the API. A new logoMetadata field has been added to the Marketer entity, and to the PromotedLink entity (available via extraFields=LogoMetaData) so an individual ad can carry its own logo.\n\nFeb 1, 2026\nNew: Section Volume Control for CBS Campaigns\n\nYou can now provide feedback on individual section performance for your CBS Auto mode campaigns (tROAS, tCPA, Max Conversion). This allows you to increase or decrease traffic volume from specific sections based on your own external data, such as LTV or ROAS. A new volumeControl object has been added to the Campaign entity to manage these adjustments.\n\nJan 4, 2026\nEnhanced Publisher and Section Exclusion Experience\n\nWe are introducing a new publisher and section exclusion experience that allows advertisers to apply temporary or permanent blocks, either individually or in bulk. This update provides clearer visibility, predictable behavior, and the ability to easily undo or adjust exclusions via the API.\n\nWhy This Matters\nPublisher traffic can spike temporarily due to breaking news or viral events, attracting audiences that may not align with advertiser intent. During these periods, campaigns often generate clicks with few conversions, inflating costs.\n\nTemporary exclusions allow you to pause this inventory while the news cycle is active. The system then automatically reintroduces the inventory once traffic normalizes—avoiding the need for unnecessary permanent blocks.\n\nTechnical Implementation: New expiration Field under blockedSites\nTo enable temporary blocking, we have added a new optional field named expiration to both the blockedPublishers and blockedSections objects under blockedSites.\n\nKey Functionalities\n\n- \nAuto-Expiration: Temporary exclusions automatically expire and reintroduce inventory without alerts.\n\n- \nRe-activation: You can now update settings for sections that were previously Permanently blocked, overriding the original exclusion state.\n\n- \nInheritance: Duplicated campaigns will inherit the existing exclusion states (Temporary or Permanent) of the original campaign.\n\nImportant Notes\n\n- \nReporting: History changes will now track the distinction between permanent and temporary exclusions.\n\n- \nCSV Limitation: Exclusions uploaded via CSV files remain Permanent by default at this time (the expiration field is not yet supported in CSV uploads).\n\nAction Required\nReview your current blocking logic. If you wish to utilize temporary blocking for viral events, update your integration to populate the expiration field in your blockedPublishers and blockedSections payloads.\n\nOct 16, 2025\nUpcoming Change to Minimum Campaign Budget Effective November 3rd 2025\n\nTo help increase campaign performance and ensure new campaigns can generate results in a timely fashion, we are adjusting the minimum required budget. This change will ensure campaigns have sufficient daily spend for our optimization systems to function effectively\n\nSummary of the Change\n\n- \nWhat: The minimum daily budget for a new campaign will be increased from $20.00 to $25.00 USD.\n\n- \nEffective Date: This change will take effect on November 3rd 2025\n\n- \nScope: This change applies only to newly created campaigns. Existing campaigns with budgets under $25.00 will continue to run without any interruption or required changes.\n\nHow This Affects You\nStarting November 3rd, 2025, any API call to the POST /budgets endpoint will enforce the following rules:\n\n- \nIf type = \"DAILY\", then amount must be greater than or equal to 25.\n\n- \nIf type = \"MONTHLY\", then amount must be greater than or equal to 750.\n\n- \nIf type = \"CAMPAIGN\", then amount must be greater than or equal to 25 x number of campaign days.\n\nAdditionally:\n\n- Any API call to the PUT /budgets endpoint to update campaigns created after November 3rd, 2025, will have the same enforcement rules outlined above.\n\nImportant Note:\nDaily limits for other currencies are exposed via the GET /currencies endpoint.\n\nAction Required\nPlease review your budget and campaign creation and update logic and ensure that any new campaigns are created with a daily budget of at least $25.00. We recommend making this update in your integration before the effective date to ensure a smooth transition.\n\nJul 8, 2025\nNew Performance Report Endpoint - Marketers Report\n\nYou can now retrieve performance reporting aggregated by Marketers aggregation, using your primary account ID.\n\nTo obtain your primary account ID, use the Marketer Entity with the extraFields=Account param.\n\nDec 22, 2024\nNew Filter Added to reporting endpoints: enabledCampaignsOnly\n\nYou can now filter data to include only active campaigns by using the enabledCampaignsOnly field when using our reporting endpoints (promoted content, Periodic, publishers, sections etc).\n\n- \nCurrent Default Value: false\n\n- \nFuture Default Value: true (effective end of January 2025)\n\nPlease note that while the current default value for en" contact: name: Outbrain Developer Center url: https://developer.outbrain.com servers: - url: https://api.outbrain.com/amplify/v0.1 description: Production Server security: - OBTokenAuth: [] tags: - name: Performance Reporting description: 'There are a multitude of reporting endpoints that allow you to retrieve metrics at various levels of granularity. Note: All performance reports have a 10-30 minutes delay, therefore performance metrics that include the current day are partial. Rate Limits Each marketer is limited to 30 requests per minute for the entire performance reporting API. In case of rate limit violation the response status will be 429 (Too Many Requests). As of April 12, 2021 performance reporting is limited to a history of 3 years per data request. Response structure All reporting endpoints share a common response structure, defined below: Property Type Semantic Comments results Array Metadata and Metrics of the entities returned. Metadata is an object containing contextual properties of the report entity. The set of properties is specific for each end-point. totalResults Number Count of the total results' paths: /reports/fullDay: get: operationId: getReportsFullDay summary: Retrieve last day of full data description: 'Return the last day for which the data in perfromance reports is complete. Result fields: Property Type Semantic fullDayDate Date Date of the last day with full performance data. modificationTime Time Modification time of the last day of full data.' tags: - Performance Reporting responses: '200': description: Successful response content: application/json: schema: type: object example: fullDayDate: '2019-07-27' modificationTime: '2019-07-28 02:55:04' headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/dataFreshness: get: operationId: getReportsDataFreshness summary: Retrieve data freshness description: 'Return the last timestamps for which the data in performance reports is available. Result fields: Property Type Semantic finalDataDate Time The last timestamp for which the data is complete, usually 0.5 - 1 hour delay. realTimeDataDate Time The last timestamp for which the data is in realtime and not yet finalized, usually 10-20 minutes delay.' tags: - Performance Reporting responses: '200': description: Successful response content: application/json: schema: type: object example: finalDataDate: '2023-07-09 00:00:00' realTimeDataDate: '2023-07-09 02:45:00' headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/accounts/{primaryAccountId}/marketers: get: operationId: getReportsAccountsPrimaryAccountIdMarketers summary: Retrieve marketers with performance statistics for a Primary Account description: 'The API in this sub-section allows retrieving primary account marketers data with performance statistics. Result fields Metrics in metrics, metadata in a metadata object containing the following fields: Property Type Semantic id String Marketer ID. name String Marketer name. status String The marketer''s delivery status: ACTIVE, DISABLED, INACTIVE (no spent in the last 30 days), PARTIALLY_ACTIVE (inactive campaign on air status)' tags: - Performance Reporting parameters: - name: primaryAccountId in: path required: true schema: type: string description: Primary Account id. account.salesForceAccountId from Marketer Entity. example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request. Used with offset for pagination. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: sort in: query required: false schema: type: string description: Can have one of the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, name, enabled, creativeFormat, budgetStartDate, budgetEndDate and budgetAmount . For more details about reports filtering read this. example: -ctr - name: filter in: query required: false schema: type: string description: Can have the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, name, enabled, creativeFormat, budgetStartDate, budgetEndDate, budgetAmount, budgetType, budgetShared and pacingType. For more details about reports filtering read this. example: clicks+gt+99 - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: results: - metadata: id: mock-id-0001 name: Mock Marketer Alpha identifier: '11111111' status: ACTIVE metrics: impressions: 227635064 clicks: 417487 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 165958.65 ecpc: 0.398 ctr: 0.18 dstFeeCost: 0 cpm: 0.73 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 appleSKAdNetworkConversions: 0 appleSKAdNetworkRedownload0: 0 appleSKAdNetworkRedownload1: 0 appleSKAdNetworkConversionValue: 0 appleSKAdNetworkConversionAverageValue: 0 - metadata: id: mock-id-0002 name: Mock Marketer Beta identifier: '22222222' status: INACTIVE metrics: impressions: 16368480 clicks: 23389 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 8591.07 ecpc: 0.367 ctr: 0.14 dstFeeCost: 0 cpm: 0.52 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 appleSKAdNetworkConversions: 0 appleSKAdNetworkRedownload0: 0 appleSKAdNetworkRedownload1: 0 appleSKAdNetworkConversionValue: 0 appleSKAdNetworkConversionAverageValue: 0 - metadata: id: mock-id-0003 name: Mock Marketer Gamma identifier: '33333333' status: INACTIVE metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 dstFeeCost: 0 cpm: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 appleSKAdNetworkConversions: 0 appleSKAdNetworkRedownload0: 0 appleSKAdNetworkRedownload1: 0 appleSKAdNetworkConversionValue: 0 appleSKAdNetworkConversionAverageValue: 0 totalResults: 3 summary: impressions: 244003544 clicks: 440876 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 174549.72 ecpc: 0.396 ctr: 0.18 dstFeeCost: 0 cpm: 0.72 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 appleSKAdNetworkConversions: 0 appleSKAdNetworkRedownload0: 0 appleSKAdNetworkRedownload1: 0 appleSKAdNetworkConversionValue: 0 appleSKAdNetworkConversionAverageValue: 0 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/campaigns: get: operationId: getReportsMarketersIdCampaigns summary: Retrieve campaigns with performance statistics for a Marketer description: 'The API in this sub-section allows retrieving marketer campaigns data with performance statistics. Result fields Metrics in metrics, metadata in a metadata object containing the following fields: Property Type Semantic id String Campaign ID. name String Campaign name. campaignOnAir Boolean Is the campaign on air, same as campaignOnAir in Live Status. onAirReason Campaign On Air Reason The reason for the campaign on air status, same as onAirReason in Live Status. enabled Boolean Is the campaign enabled. budget Budget Partial Budget entity of a campaign. For full details use Budget. lastCappingTime Time Optional. Latest date and time the campaign was capped for selected date range. Data is available for up to 30 days ago. cpc Money Cost per monetized user action (for example cost per click). See Currencies for valid cost values. creativeFormat Campaign creative format The campaign creative format.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request. Used with offset for pagination. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: sort in: query required: false schema: type: string description: Can have one of the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, name, enabled, creativeFormat, budgetStartDate, budgetEndDate and budgetAmount . For more details about reports filtering read this. example: -ctr - name: filter in: query required: false schema: type: string description: Can have the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, name, enabled, creativeFormat, budgetStartDate, budgetEndDate, budgetAmount, budgetType, budgetShared and pacingType. For more details about reports filtering read this. example: clicks+gt+99 - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: budgetId in: query required: false schema: type: string description: Limit to data of the budget with the given ID. example: adc4fc128ab0419ababf4b02153ee75f3c - name: campaignId in: query required: false schema: type: string description: Limit to data of the campaign with the given IDs (takes precedence over budgetId). example: e75f3cadc4fc128ab0419ababf4b02153e, 0069fc0fe9598f99b4c528f0881cd74b4b - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'true' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' - name: includeViewedImpressions in: query required: false schema: type: boolean description: When true, includes viewableImpressions in the response metrics. Default false. example: 'false' responses: '200': description: Successful response content: application/json: schema: type: object example: results: - metadata: id: 00f4b02153ee75f3c9dc4fc128ab041962 name: Boost 'ABC' Brand campaignOnAir: false onAirReason: CAMPAIGN_DISABLED enabled: false budget: id: 00a6bf53c0e7231db16501ea78e750d16f shared: false amount: 2500 currency: USD startDate: '2015-05-23' endDate: '' type: DAILY pacing: SPEND_ASAP cpc: 0.081 lastCappingTime: '2015-05-24 21:56:22' creativeFormat: Standard metrics: impressions: 4969401 clicks: 2061 totalConversions: 6 conversions: 5 viewConversions: 1 spend: 1532.44 ecpc: 0.74 ctr: 0.04 conversionRate: 0.24 viewConversionRate: 0 cpa: 306.49 totalCpa: 255.41 totalValue: 243.31 totalSumValue: 294.66 sumValue: 243.31 viewSumValue: 51.35 totalAverageValue: 49.11 averageValue: 48.66 viewAverageValue: 51.35 roas: 0.8 totalRoas: 0.6 conversionMetrics: - name: Purchase totalConversions: 1 conversions: 1 viewConversions: 0 conversionRate: 0.05 viewConversionRate: 0 totalCpa: 1532.44 cpa: 1532.44 totalValue: 240 totalSumValue: 240 sumValue: 240 viewSumValue: 0 totalAverageValue: 240 averageValue: 240 viewAverageValue: 0 roas: 0.3 totalRoas: 0.3 - name: View totalConversions: 102 conversions: 99 viewConversions: 3 conversionRate: 4.8 viewConversionRate: 0 totalCpa: 15.02 cpa: 15.48 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: Add To Cart totalConversions: 6 conversions: 5 viewConversions: 1 conversionRate: 0.24 viewConversionRate: 0 totalCpa: 255.41 cpa: 306.49 totalValue: 243.31 totalSumValue: 294.66 sumValue: 243.31 viewSumValue: 51.35 totalAverageValue: 49.11 averageValue: 48.66 viewAverageValue: 51.35 roas: 0.8 totalRoas: 0.7 totalResults: 19 summary: impressions: 15615028 clicks: 10756 totalConversions: 18 conversions: 17 viewConversions: 1 spend: 5693.03 ecpc: 0.53 ctr: 0.07 conversionRate: 0.16 viewConversionRate: 0 cpa: 334.88 totalCpa: 316.28 totalValue: 1099.6 totalSumValue: 1150.95 sumValue: 1099.6 viewSumValue: 51.35 totalAverageValue: 63.94 averageValue: 64.68 viewAverageValue: 51.35 roas: 0.8 totalRoas: 0.6 conversionMetrics: - name: Add To Cart totalConversions: 18 conversions: 17 viewConversions: 1 conversionRate: 0.16 viewConversionRate: 0 totalCpa: 316.28 cpa: 334.88 totalValue: 1099.6 totalSumValue: 1150.95 sumValue: 1099.6 viewSumValue: 51.35 totalAverageValue: 63.94 averageValue: 64.68 viewAverageValue: 51.35 roas: 0.3 totalRoas: 0.3 - name: Purchase totalConversions: 4 conversions: 4 viewConversions: 0 conversionRate: 0.04 viewConversionRate: 0 totalCpa: 1423.26 cpa: 1423.26 totalValue: 960 totalSumValue: 960 sumValue: 960 viewSumValue: 0 totalAverageValue: 240 averageValue: 240 viewAverageValue: 0 roas: 0.8 totalRoas: 0.7 - name: View totalConversions: 277 conversions: 272 viewConversions: 5 conversionRate: 2.53 viewConversionRate: 0 totalCpa: 20.55 cpa: 20.93 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalFilteredResults: 1 summaryFiltered: impressions: 4969401 clicks: 2061 totalConversions: 6 conversions: 5 viewConversions: 1 spend: 1532.44 ecpc: 0.74 ctr: 0.04 conversionRate: 0.24 viewConversionRate: 0 cpa: 306.49 totalCpa: 255.41 totalValue: 243.31 totalSumValue: 294.66 sumValue: 243.31 viewSumValue: 51.35 totalAverageValue: 49.11 averageValue: 48.66 viewAverageValue: 51.35 roas: 0.8 totalRoas: 0.6 conversionMetrics: - name: Add To Cart totalConversions: 6 conversions: 5 viewConversions: 1 conversionRate: 0.24 viewConversionRate: 0 totalCpa: 255.41 cpa: 306.49 totalValue: 243.31 totalSumValue: 294.66 sumValue: 243.31 viewSumValue: 51.35 totalAverageValue: 49.11 averageValue: 48.66 viewAverageValue: 51.35 roas: 0.8 totalRoas: 0.7 - name: Purchase totalConversions: 1 conversions: 1 viewConversions: 0 conversionRate: 0.05 viewConversionRate: 0 totalCpa: 1532.44 cpa: 1532.44 totalValue: 240 totalSumValue: 240 sumValue: 240 viewSumValue: 0 totalAverageValue: 240 averageValue: 240 viewAverageValue: 0 roas: 0.3 totalRoas: 0.3 - name: View totalConversions: 102 conversions: 99 viewConversions: 3 conversionRate: 4.8 viewConversionRate: 0 totalCpa: 15.02 cpa: 15.48 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/promotedContent: get: operationId: getReportsMarketersIdPromotedContent summary: Retrieve promoted content links performance statistics for a Marketer description: 'The API in this sub-section allows retrieving performance statistics by promoted link at different levels: marketer, budget, campaign and promoted link. This new endpoint also supports promoted links that are creative format: CAROUSEL and APP_INSTALL, these were previously excluded from the original Content endpoint. Please note that this endpoint is replacing the previous Content endpoint which will be removed by October 2022. Result fields Metrics in metrics, metadata in a metadata object containing the following fields: Property Type Semantic id String The ID of the PromotedLink. sequenceId String The ID of the PromotedLinkSequence. title String The title of the PromotedLink. creationTime Date The time when the PromotedLink was created. lastModified Date The time when the PromotedLink was last modified. url String The URL visitors will be sent to upon clicking the PromotedLink. status PromotedLink Review Status Deprecated, use approvalStatus instead. The review status of the PromotedLink. approvalStatus PromotedLink Approval Status The approval status of the PromotedLink. enabled Boolean Will this PromotedLink be served. cachedLogoUrl String The URL of the PromotedLink''s logo image, cached on Outbrain''s servers. campaignId String The ID of the campaign to which the PromotedLink belongs. campaignName String The name of the campaign to which the PromotedLink belongs. sectionName String The section name of the site the PromotedLink URL points to. cpcAdjustment Number CPC adjustment bid of this PromotedLink for campaign given by the campaignId parameter (optional). creativeFormat Campaign creative format The creative format of the campaign to which the PromotedLink belongs to. imageMetadata Image Meta Data PromotedLink''s image metadata metadata String non-serving reference name of the PromotedLink (optional) Special request parameters Parameter Type Semantic Details promotedLinkId String Limit to data of the promoted link with given ID Optional, takes precedence over budgetId and campaignId sequenceId String Limit to data of the promoted link sequence with given ID Optional, takes precedence over budgetId and campaignId limit Number Maximal number of results to return. Optional, default 10, maximal value 1000' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request. Used with offset for pagination. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: sort in: query required: false schema: type: string description: Can have one of the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, text, creationTime, lastModified, url, status, approvalStatus, enabled, campaignName, cpcAdjustment, creativeFormat. For more details about reports filtering read this. example: -ctr - name: filter in: query required: false schema: type: string description: Can have the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, text, creationTime, lastModified, url, status, approvalStatus, enabled, campaignName, cpcAdjustment, creativeFormat. For more details about reports filtering read this. example: clicks+gt+99 - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: budgetId in: query required: false schema: type: string description: Limit to data of the budget with the given ID. example: adc4fc128ab0419ababf4b02153ee75f3c - name: campaignId in: query required: false schema: type: string description: Limit to data of the campaign with the given IDs (takes precedence over budgetId). example: e75f3cadc4fc128ab0419ababf4b02153e, 0069fc0fe9598f99b4c528f0881cd74b4b - name: promotedLinkId in: query required: false schema: type: string description: Limit to data of the promoted link with the given ID (takes precedence over budgetId and campaignId). example: 19ababf4b02153ee75f3cadc4fc128ab04 - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: results: - metadata: id: 000a9c284d1874746b611a82198aa23983 campaignId: 00b8b57fe314cfcdcb5b18907b4940ab12 campaignName: allWifiUnchecked enabled: true creativeFormat: Standard title: '1.0' url: http://mako.co.il imageMetadata: id: 89201ae8a8714f568000fa42a486f5a25c4a6c7d96aca21fc37f636a988868c0 requestedImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6Ijg5MjAxYWU4YTg3MTRmNTY4MDAwZmE0MmE0ODZmNWEyNWM0YTZjN2Q5NmFjYTIxZmMzN2Y2MzZhOTg4ODY4YzAiLCJ3IjoxNTAsImgiOjE1MCwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg originalImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6Ijg5MjAxYWU4YTg3MTRmNTY4MDAwZmE0MmE0ODZmNWEyNWM0YTZjN2Q5NmFjYTIxZmMzN2Y2MzZhOTg4ODY4YzAiLCJ3IjoyMDUsImgiOjIwNSwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg cropSettings: - ratio: '1:1' x: 0 y: 0 w: 205 h: 205 isCustom: false - ratio: '4:3' x: 0 y: 7 w: 205 h: 154 isCustom: false - ratio: '3:2' x: 0 y: 24 w: 205 h: 137 isCustom: false - ratio: '8:5' x: 0 y: 31 w: 205 h: 128 isCustom: false - ratio: '16:9' x: 0 y: 40 w: 205 h: 115 isCustom: false - ratio: 1.91:1 x: 0 y: 56 w: 205 h: 107 isCustom: false sectionName: mako חדשות. בידור. טלוויזיה approvalStatus: status: Rejected reasons: - GatedContent isEditable: true delivery: Inactive onAirStatus: onAir: false reason: PROCESSING creationTime: '2021-07-28 05:44:51' lastModified: '2021-07-28 05:44:51' metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.0 ecpc: 0 ctr: 0 cpm: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 007ecd7f8ecbde42fd42f43e6206207d79 campaignId: 0029a075375f28ddac5d5157e014504d51 campaignName: asdfasdf enabled: true creativeFormat: Standard title: '1.0' url: http://mako.co.il imageMetadata: id: 89201ae8a8714f568000fa42a486f5a25c4a6c7d96aca21fc37f636a988868c0 requestedImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6Ijg5MjAxYWU4YTg3MTRmNTY4MDAwZmE0MmE0ODZmNWEyNWM0YTZjN2Q5NmFjYTIxZmMzN2Y2MzZhOTg4ODY4YzAiLCJ3IjoxNTAsImgiOjE1MCwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg originalImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6Ijg5MjAxYWU4YTg3MTRmNTY4MDAwZmE0MmE0ODZmNWEyNWM0YTZjN2Q5NmFjYTIxZmMzN2Y2MzZhOTg4ODY4YzAiLCJ3IjoyMDUsImgiOjIwNSwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg cropSettings: - ratio: '1:1' x: 0 y: 0 w: 205 h: 205 isCustom: false - ratio: '4:3' x: 0 y: 7 w: 205 h: 154 isCustom: false - ratio: '3:2' x: 0 y: 24 w: 205 h: 137 isCustom: false - ratio: '8:5' x: 0 y: 31 w: 205 h: 128 isCustom: false - ratio: '16:9' x: 0 y: 40 w: 205 h: 115 isCustom: false - ratio: 1.91:1 x: 0 y: 56 w: 205 h: 107 isCustom: false sectionName: mako חדשות. בידור. טלוויזיה approvalStatus: status: Rejected reasons: - ImageQualityAppearance isEditable: true qualityRating: rating: 5 manuallyOverride: false delivery: Inactive onAirStatus: onAir: false reason: PROCESSING creationTime: '2022-02-01 09:21:13' lastModified: '2022-02-01 09:21:13' metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.0 ecpc: 0 ctr: 0 cpm: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 00dae924877f63d1d773b32cf2b11854d3 campaignId: 00ae29b6fa962ed40d5d32adad78fd7a90 campaignName: Quality Rating enabled: true creativeFormat: Standard title: 1.0 4 url: http://mako.co.il?myediitedsuffixcode imageMetadata: id: 62f849d0f7d26ccff0ce05d41fe789a234f53f1c9f38e491ed9a6c91162df779 requestedImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6IjYyZjg0OWQwZjdkMjZjY2ZmMGNlMDVkNDFmZTc4OWEyMzRmNTNmMWM5ZjM4ZTQ5MWVkOWE2YzkxMTYyZGY3NzkiLCJ3IjoxNTAsImgiOjE1MCwiZCI6MS4wLCJjaCI6LTE5MTE0ODM0MDIsImNzIjoyLCJmIjowfQ.jpg originalImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6IjYyZjg0OWQwZjdkMjZjY2ZmMGNlMDVkNDFmZTc4OWEyMzRmNTNmMWM5ZjM4ZTQ5MWVkOWE2YzkxMTYyZGY3NzkiLCJ3IjozMDAsImgiOjE2OCwiZCI6MS4wLCJjaCI6LTE5MTE0ODM0MDIsImNzIjoyLCJmIjowfQ.jpg cropSettings: - ratio: '1:1' x: 40 y: 0 w: 168 h: 168 isCustom: false - ratio: '4:3' x: 41 y: 24 w: 113 h: 85 isCustom: true - ratio: '3:2' x: 85 y: 3 w: 213 h: 142 isCustom: true - ratio: '8:5' x: 0 y: 0 w: 269 h: 168 isCustom: false - ratio: '16:9' x: 0 y: 0 w: 300 h: 168 isCustom: false - ratio: 1.91:1 x: 0 y: 79 w: 165 h: 86 isCustom: true sectionName: 'The Spruce Craftskjg ' approvalStatus: status: Pending isEditable: true description: edit delivery: Inactive onAirStatus: onAir: false reason: PROCESSING creationTime: '2021-05-10 07:29:05' lastModified: '2021-06-29 05:56:05' metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.0 ecpc: 0 ctr: 0 cpm: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 002b5523b88c5c302033457fb46896887e campaignId: 00ae29b6fa962ed40d5d32adad78fd7a90 campaignName: Quality Rating enabled: true creativeFormat: Standard title: 25% off everything! url: https://www.bollandbranch.com/pages/shop-the-look?myediitedsuffixcode imageMetadata: id: a9a5dfe20e722548ca8aea489c4b959edecf2303bd6b115f3f276d4ffa7b8ca2 requestedImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6ImE5YTVkZmUyMGU3MjI1NDhjYThhZWE0ODljNGI5NTllZGVjZjIzMDNiZDZiMTE1ZjNmMjc2ZDRmZmE3YjhjYTIiLCJ3IjoxNTAsImgiOjE1MCwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg originalImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6ImE5YTVkZmUyMGU3MjI1NDhjYThhZWE0ODljNGI5NTllZGVjZjIzMDNiZDZiMTE1ZjNmMjc2ZDRmZmE3YjhjYTIiLCJ3IjoxMTg0LCJoIjoxMDIyLCJkIjoxLjAsImNzIjowLCJmIjowfQ.jpg cropSettings: - ratio: '1:1' x: 69 y: 0 w: 1022 h: 1022 isCustom: false - ratio: '4:3' x: 0 y: 0 w: 1184 h: 890 isCustom: false - ratio: '3:2' x: 0 y: 225 w: 1184 h: 789 isCustom: false - ratio: '8:5' x: 0 y: 0 w: 1184 h: 740 isCustom: false - ratio: '16:9' x: 0 y: 33 w: 1184 h: 665 isCustom: false - ratio: 1.91:1 x: 0 y: 66 w: 1184 h: 620 isCustom: false sectionName: AARP test 111 approvalStatus: status: Pending isEditable: true delivery: Inactive onAirStatus: onAir: false reason: PROCESSING creationTime: '2021-05-10 07:29:05' lastModified: '2021-06-17 04:12:34' metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.0 ecpc: 0 ctr: 0 cpm: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 00f2dfe24ac6d6de03a60d04288e2f52c3 campaignId: 00ae29b6fa962ed40d5d32adad78fd7a90 campaignName: Quality Rating enabled: true creativeFormat: Standard title: 25% off everything! 4111 url: https://www.bollandbranch.com/pages/shop-the-look?myediitedsuffixcode imageMetadata: id: a9a5dfe20e722548ca8aea489c4b959edecf2303bd6b115f3f276d4ffa7b8ca2 requestedImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6ImE5YTVkZmUyMGU3MjI1NDhjYThhZWE0ODljNGI5NTllZGVjZjIzMDNiZDZiMTE1ZjNmMjc2ZDRmZmE3YjhjYTIiLCJ3IjoxNTAsImgiOjE1MCwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg originalImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6ImE5YTVkZmUyMGU3MjI1NDhjYThhZWE0ODljNGI5NTllZGVjZjIzMDNiZDZiMTE1ZjNmMjc2ZDRmZmE3YjhjYTIiLCJ3IjoxMTg0LCJoIjoxMDIyLCJkIjoxLjAsImNzIjowLCJmIjowfQ.jpg cropSettings: - ratio: '1:1' x: 69 y: 0 w: 1022 h: 1022 isCustom: false - ratio: '4:3' x: 0 y: 0 w: 1184 h: 890 isCustom: false - ratio: '3:2' x: 0 y: 225 w: 1184 h: 789 isCustom: false - ratio: '8:5' x: 0 y: 0 w: 1184 h: 740 isCustom: false - ratio: '16:9' x: 0 y: 33 w: 1184 h: 665 isCustom: false - ratio: 1.91:1 x: 0 y: 66 w: 1184 h: 620 isCustom: false sectionName: Boll & Branch approvalStatus: status: Approved isEditable: true delivery: Inactive onAirStatus: onAir: false reason: PROCESSING creationTime: '2021-05-10 07:29:05' lastModified: '2021-06-14 09:49:59' metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.0 ecpc: 0 ctr: 0 cpm: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 00997fd539a5f7028ab318eab48fc29423 campaignId: 00ae29b6fa962ed40d5d32adad78fd7a90 campaignName: Quality Rating enabled: true creativeFormat: Standard title: Top 100 Celebrity Gossip Blogs, Websites & Influencers in 2021 2 url: https://www.aarp.org/health/conditions-treatments/info-2021/fully-vaccinated.html?myediitedsuffixcode imageMetadata: id: 75a9b747ff5e066763594c8f0bfde1f8500a9e204bfd6b70cdecce4a52f877ea requestedImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6Ijc1YTliNzQ3ZmY1ZTA2Njc2MzU5NGM4ZjBiZmRlMWY4NTAwYTllMjA0YmZkNmI3MGNkZWNjZTRhNTJmODc3ZWEiLCJ3IjoxNTAsImgiOjE1MCwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg originalImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6Ijc1YTliNzQ3ZmY1ZTA2Njc2MzU5NGM4ZjBiZmRlMWY4NTAwYTllMjA0YmZkNmI3MGNkZWNjZTRhNTJmODc3ZWEiLCJ3Ijo5MDAsImgiOjQ0MSwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg cropSettings: - ratio: '1:1' x: 251 y: 0 w: 441 h: 441 isCustom: false - ratio: '4:3' x: 209 y: 0 w: 587 h: 441 isCustom: false - ratio: '3:2' x: 188 y: 0 w: 662 h: 441 isCustom: false - ratio: '8:5' x: 168 y: 0 w: 706 h: 441 isCustom: false - ratio: '16:9' x: 107 y: 0 w: 785 h: 441 isCustom: false - ratio: 1.91:1 x: 47 y: 0 w: 842 h: 441 isCustom: false sectionName: Feedspot Blog approvalStatus: status: Approved isEditable: true delivery: Inactive onAirStatus: onAir: false reason: PROCESSING creationTime: '2021-05-10 07:29:05' lastModified: '2021-06-16 06:42:34' metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.0 ecpc: 0 ctr: 0 cpm: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: sequenceId: 00043a9f00801ca88e804b77fa08a3eeb2 campaignId: 00eb63663a643c07b237ab3b12cb2a659f campaignName: carousel crop not saved enabled: true creativeFormat: Carousel title: sivana editor test cachedLogoUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6IjI4Y2MxOWRmNGNjNDk3MWJiYWE4NTJmMmEyYzQxODJkOTk4NmE3MTNhMzFkNmE4NmFkZDJlZjExYTVhZGU1NzAiLCJ3IjoxNTAsImgiOjE1MCwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg sectionName: sivana approvalStatus: status: Pending isEditable: true delivery: Inactive onAirStatus: onAir: false reason: MISSING_RUNNING_PROMOTED_LINKS creationTime: '2021-01-04 11:51:00' lastModified: '2021-01-04 11:51:00' metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.0 ecpc: 0 ctr: 0 cpm: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 00d3000da00f16fd6bf82cfd8b62e79079 campaignId: 00244ee5035b2892aa31c53e737e1b4312 campaignName: video cmp enabled: true creativeFormat: VideoStandard title: test url: https://rtr.innovid.com/r1.5e3c62b07d10e6.70895723 imageMetadata: id: fd54309d64541efe0388e6c7e54150b947d82e83d016994724e95f4b36bec6ef requestedImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6ImZkNTQzMDlkNjQ1NDFlZmUwMzg4ZTZjN2U1NDE1MGI5NDdkODJlODNkMDE2OTk0NzI0ZTk1ZjRiMzZiZWM2ZWYiLCJ3IjoxNTAsImgiOjE1MCwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg originalImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6ImZkNTQzMDlkNjQ1NDFlZmUwMzg4ZTZjN2U1NDE1MGI5NDdkODJlODNkMDE2OTk0NzI0ZTk1ZjRiMzZiZWM2ZWYiLCJ3IjoxMjgwLCJoIjo3MjAsImQiOjEuMCwiY3MiOjAsImYiOjB9.jpg cropSettings: - ratio: '1:1' x: 473 y: 0 w: 720 h: 720 isCustom: false - ratio: '4:3' x: 302 y: 0 w: 958 h: 720 isCustom: false - ratio: '3:2' x: 132 y: 0 w: 1080 h: 720 isCustom: false - ratio: '8:5' x: 87 y: 0 w: 1152 h: 720 isCustom: false - ratio: '16:9' x: 0 y: 0 w: 1280 h: 720 isCustom: false - ratio: 1.91:1 x: 0 y: 0 w: 1280 h: 670 isCustom: false sectionName: test approvalStatus: status: Approved isEditable: true delivery: Inactive onAirStatus: onAir: false reason: PROCESSING creationTime: '2021-09-09 15:41:00' lastModified: '2021-09-09 15:41:00' metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.0 ecpc: 0 ctr: 0 cpm: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 007ccfa832d14836373a880ef9fe9764ae campaignId: 00ae29b6fa962ed40d5d32adad78fd7a90 campaignName: Quality Rating enabled: true creativeFormat: Standard title: סטטוסים מצייצים | האתר הרישמי 3 url: https://sta2sim.com/?myediitedsuffixcode imageMetadata: id: 24f56ca59783db57b0960610b41c15f6b9cacc6a1055c5e667ccac9be26900db requestedImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6IjI0ZjU2Y2E1OTc4M2RiNTdiMDk2MDYxMGI0MWMxNWY2YjljYWNjNmExMDU1YzVlNjY3Y2NhYzliZTI2OTAwZGIiLCJ3IjoxNTAsImgiOjE1MCwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg originalImageUrl: http://images-sim.outbrain.com/Imaginarium/api/transform/v3/eyJpdSI6IjI0ZjU2Y2E1OTc4M2RiNTdiMDk2MDYxMGI0MWMxNWY2YjljYWNjNmExMDU1YzVlNjY3Y2NhYzliZTI2OTAwZGIiLCJ3Ijo2MDAsImgiOjQyMCwiZCI6MS4wLCJjcyI6MCwiZiI6MH0.jpg cropSettings: - ratio: '1:1' x: 158 y: 0 w: 420 h: 420 isCustom: false - ratio: '4:3' x: 38 y: 0 w: 559 h: 420 isCustom: false - ratio: '3:2' x: 0 y: 7 w: 600 h: 400 isCustom: false - ratio: '8:5' x: 0 y: 31 w: 600 h: 375 isCustom: false - ratio: '16:9' x: 0 y: 79 w: 600 h: 337 isCustom: false - ratio: 1.91:1 x: 0 y: 95 w: 600 h: 314 isCustom: false sectionName: סטטוסים מצייצים approvalStatus: status: Pending isEditable: true delivery: Inactive onAirStatus: onAir: false reason: PROCESSING creationTime: '2021-05-10 07:29:05' lastModified: '2021-05-10 07:29:05' metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.0 ecpc: 0 ctr: 0 cpm: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 totalResults: 9 summary: impressions: 0.0 clicks: 0.0 totalConversions: 0.0 conversions: 0.0 viewConversions: 0.0 spend: 0.0 ecpc: 0 ctr: 0 cpm: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 conversionMetrics: - name: sixteen totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: remove totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: six totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: three totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: checked totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: one totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: Conv with value totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: eight totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: eleven totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: inactive totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: Pages Per Session totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: Conv with value 2 totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: test1 totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: fourteen totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: eighteen totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: test totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: nine totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: New min value totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: fifteen totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: Session Duration totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: seventeen totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: twelve totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: ten totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: thirteen totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: With value disabled totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: four totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: seven totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: event no value totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: five totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: url no value totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 - name: two totalConversions: 0 conversions: 0 viewConversions: 0 conversionRate: 0 viewConversionRate: 0 totalCpa: 0 cpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/periodic: get: operationId: getReportsMarketersIdPeriodic summary: Retrieve periodic performance statistics for a Marketer description: 'The API in this sub-section allows retrieving performance statistics by periodic breakdown at different levels: marketer, budget, campaign and promoted link. Special request parameters Parameter Type Semantic Details breakdown String Defines the periodic breakdown of data, either daily, weekly, monthly, hourOfDay, dayOfWeek or dayOfWeekByHour. Optional, default value daily. promotedLinkId String Limit to data of the promoted link with given ID. Optional, takes precedence over budgetId and campaignId. Not allowed with hourOfDay or dayOfWeekByHour breakdown. Result fields Metrics in metrics, metadata in a metadata object containing the following fields: Property Type Supported Breakdowns Semantic id String All date range identifier (month in format ''yyyy-MM'' or start date in format ''yyyy-MM-dd'', or day of week and hour in format ''d-HH'') fromDate Date daily, weekly, monthly The first day of the result date period. toDate Date daily, weekly, monthly The last day of the result date period (inclusive). lastCappingTime Time portion of Time, in format "HH:mm:ss". daily for a single campaign. Optional. The time the campaign was capped during that date. Data is available for up to 30 days ago. hourOfDay String hourOfDay, dayOfWeekByHour The day of the week (Monday, Tuesday, etc.) of the result period. dayOfWeek Hour Of Day dayOfWeek, dayOfWeekByHour The hour of day of the result period. cpcAdjustment Number dayOfWeekByHour CPC adjustment bid of this day and hour for campaign given by the campaignId parameter (optional). enabled Boolean dayOfWeekByHour The scheduling status of this day and hour for campaign given by the campaignId parameter (optional).' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request. Used with offset for pagination. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: sort in: query required: false schema: type: string description: Can have one of the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, id, fromDate and toDate. For more details about reports filtering read this. example: -ctr - name: filter in: query required: false schema: type: string description: Can have the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, id, fromDate and toDate. For more details about reports filtering read this. example: clicks+gt+99 - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: budgetId in: query required: false schema: type: string description: Limit to data of the budget with the given ID. example: adc4fc128ab0419ababf4b02153ee75f3c - name: campaignId in: query required: false schema: type: string description: Limit to data of the campaign with the given IDs (takes precedence over budgetId). example: e75f3cadc4fc128ab0419ababf4b02153e, 0069fc0fe9598f99b4c528f0881cd74b4b - name: promotedLinkId in: query required: false schema: type: string description: Limit to data of the promoted link with the given ID (takes precedence over budgetId and campaignId). example: 19ababf4b02153ee75f3cadc4fc128ab04 - name: breakdown in: query required: false schema: type: string description: Defines the periodic breakdown of data, either daily, weekly, monthly, hourOfDay, dayOfWeek or dayOfWeekByHour. Default is daily. example: monthly - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' - name: includeViewedImpressions in: query required: false schema: type: boolean description: When true, includes viewableImpressions in the response metrics. example: 'false' responses: '200': description: Successful response content: application/json: schema: type: object example: results: - metadata: id: '2019-05-20' fromDate: '2019-05-20' toDate: '2019-05-20' metrics: impressions: 1369013 clicks: 935 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 520.3 ecpc: 0.56 ctr: 0.07 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2019-05-19' fromDate: '2019-05-19' toDate: '2019-05-19' metrics: impressions: 675890 clicks: 920 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 383.29 ecpc: 0.42 ctr: 0.14 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2019-05-18' fromDate: '2019-05-18' toDate: '2019-05-18' metrics: impressions: 891466 clicks: 740 totalConversions: 2 conversions: 2 viewConversions: 0 spend: 358.33 ecpc: 0.48 ctr: 0.08 conversionRate: 0.27 viewConversionRate: 0 cpa: 179.17 totalCpa: 179.17 totalValue: 95.98 totalSumValue: 95.98 sumValue: 95.98 viewSumValue: 0 totalAverageValue: 47.99 averageValue: 47.99 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 totalResults: 3 summary: impressions: 2936369 clicks: 2595 totalConversions: 2 conversions: 2 viewConversions: 0 spend: 1261.92 ecpc: 0.49 ctr: 0.09 conversionRate: 0.08 viewConversionRate: 0 cpa: 630.96 totalCpa: 630.96 totalValue: 95.98 totalSumValue: 95.98 sumValue: 95.98 viewSumValue: 0 totalAverageValue: 47.99 averageValue: 47.99 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/campaigns/periodic: get: operationId: getReportsMarketersIdCampaignsPeriodic summary: Retrieve performance statistics for all marketer campaigns by periodic breakdown description: 'A special endpoint for retrieving periodic data by campaign breakdown. Now supports all breakdowns: daily, weekly, monthly, hourOfDay, dayOfWeek and dayOfWeekByHour. Note: The response structure defers from other performance responses. The reponse contains only campaigns that have periodic results given the offset and limit, in the following two objects: Property Type Semantic campaignResults Array Results for the marketer campaigns. Each object in the array contains results and totalResults field similar to the response of the Periodic request, and an additional campaignId field with the campaign ID. totalCampaigns Number Count of the total campaigns in the campaignResults array.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each campaign. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: breakdown in: query required: false schema: type: string description: Defines the periodic breakdown of data, either daily, weekly, monthly, hourOfDay, dayOfWeek or dayOfWeekByHour. Default is daily. example: monthly - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' - name: includeViewedImpressions in: query required: false schema: type: boolean description: When true, includes viewableImpressions in the response metrics. example: 'false' responses: '200': description: Successful response content: application/json: schema: type: object example: campaignResults: - campaignId: 08ba87b1aa166a8fdc3400ad6d14789dda results: - metadata: id: '2019-05-12' fromDate: '2019-05-12' toDate: '2019-05-12' metrics: impressions: 93072 clicks: 101 totalConversions: 2 conversions: 2 viewConversions: 0 spend: 85.96 ecpc: 0.85 ctr: 0.11 conversionRate: 1.98 viewConversionRate: 0 cpa: 42.98 totalCpa: 42.98 totalValue: 97.98 totalSumValue: 97.98 sumValue: 97.98 viewSumValue: 0 totalAverageValue: 48.99 averageValue: 48.99 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 - metadata: id: '2019-05-11' fromDate: '2019-05-11' toDate: '2019-05-11' metrics: impressions: 31391 clicks: 13 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 9.24 ecpc: 0.71 ctr: 0.04 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2019-05-10' fromDate: '2019-05-10' toDate: '2019-05-10' metrics: impressions: 114846 clicks: 30 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 22.05 ecpc: 0.74 ctr: 0.03 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 3 - campaignId: 0042d2865b03b4d59f69c9b1cb254d22fa results: - metadata: id: '2019-05-12' fromDate: '2019-05-12' toDate: '2019-05-12' metrics: impressions: 35254 clicks: 41 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 16.8 ecpc: 0.41 ctr: 0.12 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2019-05-11' fromDate: '2019-05-11' toDate: '2019-05-11' lastCappingTime: '19:02:33' metrics: impressions: 394581 clicks: 479 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 201.18 ecpc: 0.42 ctr: 0.12 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2019-05-10' fromDate: '2019-05-10' toDate: '2019-05-10' lastCappingTime: '16:56:15' metrics: impressions: 432104 clicks: 480 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 201.6 ecpc: 0.42 ctr: 0.11 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 3 - campaignId: 00cc27350e45a8a188b424165f65d6facc results: - metadata: id: '2019-05-12' fromDate: '2019-05-12' toDate: '2019-05-12' metrics: impressions: 1235717 clicks: 445 totalConversions: 1 conversions: 1 viewConversions: 0 spend: 318.78 ecpc: 0.72 ctr: 0.04 conversionRate: 0.22 viewConversionRate: 0 cpa: 318.78 totalCpa: 318.78 totalValue: 47.99 totalSumValue: 47.99 sumValue: 47.99 viewSumValue: 0 totalAverageValue: 47.99 averageValue: 47.99 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 - metadata: id: '2019-05-11' fromDate: '2019-05-11' toDate: '2019-05-11' metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2019-05-10' fromDate: '2019-05-10' toDate: '2019-05-10' metrics: impressions: 0 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 3 totalCampaigns: 3 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/campaigns/periodicHourly: get: operationId: getReportsMarketersIdCampaignsPeriodicHourly summary: Retrieve performance statistics for all marketer campaigns by periodic hourly breakdown description: 'A special endpoint for retrieving periodic data by campaign in hourly breakdown. Note: The response structure defers from other performance responses. The reponse contains only campaigns that have periodic results given the offset and limit, in the following two objects: Property Type Semantic campaignResults Array Results for the marketer campaigns. Each object in the array contains results and totalResults field similar to the response of the Periodic request, and an additional campaignId field with the campaign ID. totalCampaigns Number Count of the total campaigns in the campaignResults array.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: hours in: query required: false schema: type: number description: Number of hours to return from now. Default is 24, Maximum is 48 hours. example: '24' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each campaign. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: breakdown in: query required: false schema: type: string description: Defines the periodic breakdown of data, either daily, weekly, monthly, hourOfDay, dayOfWeek or dayOfWeekByHour. Default is daily. example: monthly - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: campaignResults: - campaignId: 00794b5d12563a4ab03e9f43b2014xxx19 results: - metadata: id: '2023-07-09 06:00:00' fromDate: '2023-07-09 06:00:00' toDate: '2023-07-09 07:00:00' metrics: impressions: 23.0 clicks: 12.0 totalConversions: 0.0 conversions: 0.0 viewConversions: 0.0 spend: 0.0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 - metadata: id: '2023-07-09 05:00:00' fromDate: '2023-07-09 05:00:00' toDate: '2023-07-09 06:00:00' metrics: impressions: 23.0 clicks: 1.0 totalConversions: 0.0 conversions: 0.0 viewConversions: 0.0 spend: 0.0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 - metadata: id: '2023-07-09 04:00:00' fromDate: '2023-07-09 04:00:00' toDate: '2023-07-09 05:00:00' metrics: impressions: 0.0 clicks: 0.0 totalConversions: 0.0 conversions: 0.0 viewConversions: 0.0 spend: 0.0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 totalResults: 3 totalCampaigns: 1 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/campaigns/periodicMinutely: get: operationId: getReportsMarketersIdCampaignsPeriodicMinutely summary: Retrieve performance statistics for all marketer campaigns by periodic minutely breakdown description: 'A special endpoint for retrieving periodic data by campaign in minutely breakdown. Note: The response structure defers from other performance responses. The reponse contains only campaigns that have periodic results given the offset and limit, in the following two objects: Property Type Semantic campaignResults Array Results for the marketer campaigns. Each object in the array contains results and totalResults field similar to the response of the Periodic request, and an additional campaignId field with the campaign ID. totalCampaigns Number Count of the total campaigns in the campaignResults array.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: minutes in: query required: false schema: type: number description: Number of minutes to return from now, default is 60, Max is 120. example: '60' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each campaign, default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: breakdown in: query required: false schema: type: string description: Defines the periodic breakdown of data, either daily, weekly, monthly, hourOfDay, dayOfWeek or dayOfWeekByHour. Default is daily. example: monthly - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: campaignResults: - campaignId: 00794b5d12563a4ab03e9f43b2014xxx19 results: - metadata: id: '2023-07-09 07:50:00' fromDate: '2023-07-09 07:50:00' toDate: '2023-07-09 07:55:00' metrics: impressions: 23.0 clicks: 12.0 totalConversions: 0.0 conversions: 0.0 viewConversions: 0.0 spend: 0.0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 - metadata: id: '2023-07-09 07:45:00' fromDate: '2023-07-09 07:45:00' toDate: '2023-07-09 07:50:00' metrics: impressions: 23.0 clicks: 1.0 totalConversions: 0.0 conversions: 0.0 viewConversions: 0.0 spend: 0.0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0 videoPlays: 0 totalResults: 2 totalCampaigns: 1 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/campaigns/{campaignId}/periodicContent: get: operationId: getReportsMarketersIdCampaignsCampaignIdPeriodicContent summary: Retrieve periodic performance statistics by promoted link for a campaign description: 'A special endpoint for retrieving periodic data by promoted link breakdown for a given campaign. Note: The response structure defers from other performance responses. The reponse contains only promoted links that have periodic results given the offset and limit, in the following two objects: Property Type Semantic promotedLinkResults Array Results for the campaign promoted links. Each object in the array contains results and totalResults field similar to the response of the Periodic request, and an additional promotedLinkId field with the campaign ID. totalPromotedLinks Number Count of the total promoted links in the promotedLinkResults array.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: campaignId in: path required: true schema: type: string description: Limit to data of the campaign with the given IDs. example: e75f3cadc4fc128ab0419ababf4b02153e, 0069fc0fe9598f99b4c528f0881cd74b4b - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each campaign. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. Default is 0. example: '3' - name: breakdown in: query required: false schema: type: string description: Defines the periodic breakdown of data, either daily, weekly or monthly. Default is daily. example: monthly - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: promotedLinkResults: - promotedLinkId: 00eb6326d9aae6274257e1a7859f6b5def results: - metadata: id: '2019-05-12' fromDate: '2019-05-12' toDate: '2019-05-12' metrics: impressions: 6038 clicks: 3 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 2.52 ecpc: 0.84 ctr: 0.05 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2019-05-11' fromDate: '2019-05-11' toDate: '2019-05-11' metrics: impressions: 4116 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 - promotedLinkId: 00df91d18ad09d7e2c921de63e46e917d1 results: - metadata: id: '2019-05-12' fromDate: '2019-05-12' toDate: '2019-05-12' metrics: impressions: 5015 clicks: 1 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.84 ecpc: 0.84 ctr: 0.02 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2019-05-11' fromDate: '2019-05-11' toDate: '2019-05-11' metrics: impressions: 4630 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 - promotedLinkId: 00ce19691b1d5d249ed895e8a380c5747f results: - metadata: id: '2019-05-12' fromDate: '2019-05-12' toDate: '2019-05-12' metrics: impressions: 9235 clicks: 4 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 3.99 ecpc: 1 ctr: 0.04 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2019-05-11' fromDate: '2019-05-11' toDate: '2019-05-11' metrics: impressions: 972 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 - promotedLinkId: 0068ac63f28b26744224df62a82f7e8352 results: - metadata: id: '2019-05-12' fromDate: '2019-05-12' toDate: '2019-05-12' metrics: impressions: 10947 clicks: 8 totalConversions: 1 conversions: 1 viewConversions: 0 spend: 6.93 ecpc: 0.87 ctr: 0.07 conversionRate: 12.5 viewConversionRate: 0 cpa: 6.93 totalCpa: 6.93 totalValue: 49.99 totalSumValue: 49.99 sumValue: 49.99 viewSumValue: 0 totalAverageValue: 49.99 averageValue: 49.99 viewAverageValue: 0 roas: 7.2 totalRoas: 7.2 - metadata: id: '2019-05-11' fromDate: '2019-05-11' toDate: '2019-05-11' metrics: impressions: 890 clicks: 1 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 1.05 ecpc: 1.05 ctr: 0.11 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 - promotedLinkId: 00345683227f1cbb7e6f025f0eee22c05c results: - metadata: id: '2019-05-12' fromDate: '2019-05-12' toDate: '2019-05-12' metrics: impressions: 2422 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2019-05-11' fromDate: '2019-05-11' toDate: '2019-05-11' metrics: impressions: 1677 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 - promotedLinkId: 00d2aef767c1f34c087be00855b9ea3dd0 results: - metadata: id: '2019-05-12' fromDate: '2019-05-12' toDate: '2019-05-12' metrics: impressions: 59415 clicks: 85 totalConversions: 1 conversions: 1 viewConversions: 0 spend: 71.68 ecpc: 0.84 ctr: 0.14 conversionRate: 1.18 viewConversionRate: 0 cpa: 71.68 totalCpa: 71.68 totalValue: 47.99 totalSumValue: 47.99 sumValue: 47.99 viewSumValue: 0 totalAverageValue: 47.99 averageValue: 47.99 viewAverageValue: 0 roas: 0.6 totalRoas: 0.6 - metadata: id: '2019-05-11' fromDate: '2019-05-11' toDate: '2019-05-11' metrics: impressions: 19106 clicks: 12 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 8.19 ecpc: 0.68 ctr: 0.06 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 totalPromotedLinks: 6 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/campaigns/{campaignId}/periodicContentHourly: get: operationId: getReportsMarketersIdCampaignsCampaignIdPeriodicContentHourly summary: Retrieve hourly periodic performance statistics by promoted link for a campaign description: 'An endpoint for retrieving periodic data by promoted link for a given campaign in an hourly breakdown - limited to last 48 hours. Note: The response structure defers from other performance responses. The reponse contains only promoted links that have periodic results given the offset and limit, in the following two objects: Property Type Semantic promotedLinkResults Array Results for the campaign promoted links. Each object in the array contains results and totalResults field similar to the response of the Periodic request, and an additional promotedLinkId field with the campaign ID. totalPromotedLinks Number Count of the total promoted links in the promotedLinkResults array.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: campaignId in: path required: true schema: type: string description: Limit to data of the campaign with the given IDs. example: e75f3cadc4fc128ab0419ababf4b02153e, 0069fc0fe9598f99b4c528f0881cd74b4b - name: hours in: query required: false schema: type: number description: Number of hours to return from now. Default is 24, Maximum is 48 hours. example: '24' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each campaign. Default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. Default is 0. example: '3' - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: promotedLinkResults: - promotedLinkId: 00eb6326d9aae6274257e1a7859f6b5def results: - metadata: id: '2023-06-18 06:00:00' fromDate: '2023-06-18 06:00:00' toDate: '2023-06-18 07:00:00' metrics: impressions: 6038 clicks: 3 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 2.52 ecpc: 0.84 ctr: 0.05 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2023-06-18 05:00:00' fromDate: '2023-06-18 05:00:00' toDate: '2023-06-18 06:00:00' metrics: impressions: 4116 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 - promotedLinkId: 00df91d18ad09d7e2c921de63e46e917d1 results: - metadata: id: '2023-06-18 06:00:00' fromDate: '2023-06-18 06:00:00' toDate: '2023-06-18 07:00:00' metrics: impressions: 5015 clicks: 1 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.84 ecpc: 0.84 ctr: 0.02 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2023-06-18 05:00:00' fromDate: '2023-06-18 05:00:00' toDate: '2023-06-18 06:00:00' metrics: impressions: 4630 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 - promotedLinkId: 00ce19691b1d5d249ed895e8a380c5747f results: - metadata: id: '2023-06-18 06:00:00' fromDate: '2023-06-18 06:00:00' toDate: '2023-06-18 07:00:00' metrics: impressions: 9235 clicks: 4 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 3.99 ecpc: 1 ctr: 0.04 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2023-06-18 05:00:00' fromDate: '2023-06-18 05:00:00' toDate: '2023-06-18 06:00:00' metrics: impressions: 972 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 - promotedLinkId: 0068ac63f28b26744224df62a82f7e8352 results: - metadata: id: '2023-06-18 06:00:00' fromDate: '2023-06-18 06:00:00' toDate: '2023-06-18 07:00:00' metrics: impressions: 10947 clicks: 8 totalConversions: 1 conversions: 1 viewConversions: 0 spend: 6.93 ecpc: 0.87 ctr: 0.07 conversionRate: 12.5 viewConversionRate: 0 cpa: 6.93 totalCpa: 6.93 totalValue: 49.99 totalSumValue: 49.99 sumValue: 49.99 viewSumValue: 0 totalAverageValue: 49.99 averageValue: 49.99 viewAverageValue: 0 roas: 7.2 totalRoas: 7.2 - metadata: id: '2023-06-18 05:00:00' fromDate: '2023-06-18 05:00:00' toDate: '2023-06-18 06:00:00' metrics: impressions: 890 clicks: 1 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 1.05 ecpc: 1.05 ctr: 0.11 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 - promotedLinkId: 00345683227f1cbb7e6f025f0eee22c05c results: - metadata: id: '2023-06-18 06:00:00' fromDate: '2023-06-18 06:00:00' toDate: '2023-06-18 07:00:00' metrics: impressions: 2422 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: '2023-06-18 05:00:00' fromDate: '2023-06-18 05:00:00' toDate: '2023-06-18 06:00:00' metrics: impressions: 1677 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 - promotedLinkId: 00d2aef767c1f34c087be00855b9ea3dd0 results: - metadata: id: '2023-06-18 06:00:00' fromDate: '2023-06-18 06:00:00' toDate: '2023-06-18 07:00:00' metrics: impressions: 59415 clicks: 85 totalConversions: 1 conversions: 1 viewConversions: 0 spend: 71.68 ecpc: 0.84 ctr: 0.14 conversionRate: 1.18 viewConversionRate: 0 cpa: 71.68 totalCpa: 71.68 totalValue: 47.99 totalSumValue: 47.99 sumValue: 47.99 viewSumValue: 0 totalAverageValue: 47.99 averageValue: 47.99 viewAverageValue: 0 roas: 0.6 totalRoas: 0.6 - metadata: id: '2023-06-18 05:00:00' fromDate: '2023-06-18 05:00:00' toDate: '2023-06-18 06:00:00' metrics: impressions: 19106 clicks: 12 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 8.19 ecpc: 0.68 ctr: 0.06 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 totalPromotedLinks: 6 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/publishers: get: operationId: getReportsMarketersIdPublishers summary: Retrieve performance statistics for a Marketer by publisher description: 'Publisher: A content site that displays Outbrain recommendations on which your promoted content appeared. The API in this sub-section allows retrieving marketer performance statistics with breakdown by publisher with publishers that are already blocked at the marketer or campaign level. Result Fields Metrics in metrics, metadata in a metadata object containing the following fields: Property Type Semantic id String Publisher Identifier. name String Publisher Name. blockStatus Block status Blocking status of the publisher. blockTypes Block types Block types and their value for the publisher. url String Publisher''s site URL (optional). isOen Boolean Is this an OEN (Outbrain Extended Network) publisher. (Planned removal October 18th)' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request. Used with offset for pagination. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: sort in: query required: false schema: type: string description: Can have one of the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, name. For more details about reports filtering read this. example: -ctr - name: filter in: query required: false schema: type: string description: Can have the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, name. For more details about reports filtering read this. example: clicks+gt+99 - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: budgetId in: query required: false schema: type: string description: Limit to data of the budget with the given ID. example: adc4fc128ab0419ababf4b02153ee75f3c - name: campaignId in: query required: false schema: type: string description: Limit to data of the campaign with the given IDs (takes precedence over budgetId). example: e75f3cadc4fc128ab0419ababf4b02153e, 0069fc0fe9598f99b4c528f0881cd74b4b - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: string example: "{\n \"results\": [\n {\n \"metadata\": {\n \"id\": \"00547603d924c481d2d75bb9500f4151fe\",\n \"name\": \"The Washington Times\",\n \"url\": \"http://www.washingtontimes.com/\",\n\"blockStatus\": \"Unblocked\",\n \"blockTypes\": {\n \"blockTypes\": {\n \"marketerPublisher\": false,\n \"marketerSection\": false,\n \"campaignPublisher\": false,\n \"campaignSection\": false,\n \"oenOptOut\": false\n },\n \"isOen\": false\n },\n \"metrics\": {\n \"impressions\": 31495,\n \"clicks\": 19,\n \"totalConversions\": 1,\n \"conversions\": 1,\n \"viewConversions\": 0,\n \"spend\": 19.95,\n \"ecpc\": 1.05,\n \"ctr\": 0.06,\n \"conversionRate\": 5.26,\n \"viewConversionRate\": 0,\n \"cpa\": 19.95,\n \"totalCpa\": 19.95,\n \"totalValue\": 49.99,\n \"totalSumValue\": 49.99,\n \"sumValue\": 49.99,\n \"viewSumValue\": 0,\n \"totalAverageValue\": 49.99,\n \"averageValue\": 49.99,\n \"viewAverageValue\": 0,\n \"roas\": 2.1,\n \"totalRoas\": 2.1\n }\n }\n ],\n \"totalResults\": 850,\n \"summary\": {\n \"impressions\": 2336965,\n \"clicks\": 1589,\n \"totalConversions\": 3,\n \"conversions\": 3,\n \"viewConversions\": 0,\n \"spend\": 855.6,\n \"ecpc\": 0.54,\n \"ctr\": 0.07,\n \"conversionRate\": 0.19,\n \"viewConversionRate\": 0,\n \"cpa\": 285.2,\n \"totalCpa\": 285.2,\n " headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/campaigns/publishers: get: operationId: getReportsMarketersIdCampaignsPublishers summary: Retrieve performance statistics for all marketer campaigns by publisher description: 'A special endpoint for retrieving publishers data by campaign breakdown. Note: The response structure defers from other performance responses. The reponse contains only campaigns that have publishers results given the offset and limit, in the following two objects: Property Type Semantic campaignResults Array Results for the marketer campaigns. Each object in the array contains results and totalResults field similar to the response of the Publishers request (except for the blockStatus and blockTypes fields in the metadata field of each result), and an additional campaignId field with the campaign ID. totalCampaigns Number Count of the total campaigns in the campaignResults array.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each campaign. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: campaignResults: - campaignId: 00d467100e5e10d8d937cb0a6a6efd7a5d results: - metadata: id: 007d5bdae84ea9f865307ba5e95aa29dda name: CNN Edition (Turner International) url: http://edition.cnn.com metrics: impressions: 722393 clicks: 1266 totalConversions: 64 conversions: 64 viewConversions: 0 spend: 712.9 ecpc: 0.56 ctr: 0.18 conversionRate: 5.06 viewConversionRate: 0 cpa: 11.14 totalCpa: 11.14 totalValue: 252 totalSumValue: 252 sumValue: 252 viewSumValue: 0 totalAverageValue: 3.94 averageValue: 3.94 viewAverageValue: 0 roas: 2.1 totalRoas: 2.1 conversionMetrics: - name: Signup totalConversions: 1 conversions: 1 viewConversions: 0 conversionRate: 0.08 viewConversionRate: 0 totalCpa: 712.9 cpa: 712.9 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: Install totalConversions: 63 conversions: 63 viewConversions: 0 conversionRate: 4.98 viewConversionRate: 0 totalCpa: 11.32 cpa: 11.32 totalValue: 252 totalSumValue: 252 sumValue: 252 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.7 - name: Engagement totalConversions: 98 conversions: 97 viewConversions: 1 conversionRate: 7.66 viewConversionRate: 0 totalCpa: 7.27 cpa: 7.35 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: Mobile totalConversions: 43 conversions: 43 viewConversions: 0 conversionRate: 3.4 viewConversionRate: 0 totalCpa: 16.58 cpa: 16.58 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 0048938c4af9641f2e04565be89ece5954 name: CNN (Turner U.S.) url: https://www.cnn.com metrics: impressions: 385376 clicks: 490 totalConversions: 18 conversions: 18 viewConversions: 0 spend: 262.47 ecpc: 0.54 ctr: 0.13 conversionRate: 3.67 viewConversionRate: 0 cpa: 14.58 totalCpa: 14.58 totalValue: 72 totalSumValue: 72 sumValue: 72 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.8 conversionMetrics: - name: Install totalConversions: 18 conversions: 18 viewConversions: 0 conversionRate: 3.67 viewConversionRate: 0 totalCpa: 14.58 cpa: 14.58 totalValue: 72 totalSumValue: 72 sumValue: 72 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.7 - name: Engagement totalConversions: 29 conversions: 28 viewConversions: 1 conversionRate: 5.71 viewConversionRate: 0 totalCpa: 9.05 cpa: 9.37 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: Mobile totalConversions: 6 conversions: 6 viewConversions: 0 conversionRate: 1.22 viewConversionRate: 0 totalCpa: 43.75 cpa: 43.75 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 815 - campaignId: 004c5152822eb27af11d7e0676cb2c84f6 results: - metadata: id: 007d5bdae84ea9f865307ba5e95aa29dda name: CNN Edition (Turner International) url: http://edition.cnn.com metrics: impressions: 446299 clicks: 516 totalConversions: 23 conversions: 23 viewConversions: 0 spend: 112.5 ecpc: 0.22 ctr: 0.12 conversionRate: 4.46 viewConversionRate: 0 cpa: 4.89 totalCpa: 4.89 totalValue: 92 totalSumValue: 92 sumValue: 92 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.8 totalRoas: 1.1 conversionMetrics: - name: Install totalConversions: 23 conversions: 23 viewConversions: 0 conversionRate: 4.46 viewConversionRate: 0 totalCpa: 4.89 cpa: 4.89 totalValue: 92 totalSumValue: 92 sumValue: 92 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.7 - name: Engagement totalConversions: 29 conversions: 28 viewConversions: 1 conversionRate: 5.43 viewConversionRate: 0 totalCpa: 3.88 cpa: 4.02 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: Mobile totalConversions: 7 conversions: 7 viewConversions: 0 conversionRate: 1.36 viewConversionRate: 0 totalCpa: 16.07 cpa: 16.07 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 00e41072cc5f59e36c8be9b36b8208ac4c name: Microsoft One Promo Canada_EN (Microsoft One Promo) url: https://www.microsoft.com metrics: impressions: 93744 clicks: 177 totalConversions: 1 conversions: 1 viewConversions: 0 spend: 38.77 ecpc: 0.22 ctr: 0.19 conversionRate: 0.56 viewConversionRate: 0 cpa: 38.77 totalCpa: 38.77 totalValue: 4 totalSumValue: 4 sumValue: 4 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.6 conversionMetrics: - name: Install totalConversions: 1 conversions: 1 viewConversions: 0 conversionRate: 0.56 viewConversionRate: 0 totalCpa: 38.77 cpa: 38.77 totalValue: 4 totalSumValue: 4 sumValue: 4 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.6 - name: Engagement totalConversions: 2 conversions: 0 viewConversions: 2 conversionRate: 0 viewConversionRate: 0 totalCpa: 19.39 cpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 909 - campaignId: 00d2f861c8cf1e9b1e1394b15f24aec493 results: - metadata: id: 0048938c4af9641f2e04565be89ece5954 name: CNN (Turner U.S.) url: https://www.cnn.com metrics: impressions: 485570 clicks: 1309 totalConversions: 40 conversions: 40 viewConversions: 0 spend: 343.26 ecpc: 0.26 ctr: 0.27 conversionRate: 3.06 viewConversionRate: 0 cpa: 8.58 totalCpa: 8.58 totalValue: 160 totalSumValue: 160 sumValue: 160 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.8 conversionMetrics: - name: Install totalConversions: 40 conversions: 40 viewConversions: 0 conversionRate: 3.06 viewConversionRate: 0 totalCpa: 8.58 cpa: 8.58 totalValue: 160 totalSumValue: 160 sumValue: 160 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.7 - name: Engagement totalConversions: 97 conversions: 97 viewConversions: 0 conversionRate: 7.41 viewConversionRate: 0 totalCpa: 3.54 cpa: 3.54 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: Mobile totalConversions: 18 conversions: 18 viewConversions: 0 conversionRate: 1.38 viewConversionRate: 0 totalCpa: 19.07 cpa: 19.07 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 006f78b958c0719b007fc916075c4d3449 name: Time Magazine (Meredith) url: https://time.com metrics: impressions: 298634 clicks: 1044 totalConversions: 37 conversions: 37 viewConversions: 0 spend: 333.84 ecpc: 0.32 ctr: 0.35 conversionRate: 3.54 viewConversionRate: 0 cpa: 9.02 totalCpa: 9.02 totalValue: 148 totalSumValue: 148 sumValue: 148 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.8 totalRoas: 0.8 conversionMetrics: - name: Install totalConversions: 37 conversions: 37 viewConversions: 0 conversionRate: 3.54 viewConversionRate: 0 totalCpa: 9.02 cpa: 9.02 totalValue: 148 totalSumValue: 148 sumValue: 148 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.8 totalRoas: 0.8 - name: Engagement totalConversions: 100 conversions: 99 viewConversions: 1 conversionRate: 9.48 viewConversionRate: 0 totalCpa: 3.34 cpa: 3.37 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: Mobile totalConversions: 24 conversions: 24 viewConversions: 0 conversionRate: 2.3 viewConversionRate: 0 totalCpa: 13.91 cpa: 13.91 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 824 totalCampaigns: 3 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/sections: get: operationId: getReportsMarketersIdSections summary: Retrieve performance statistics for a Marketer by section description: 'Section: A specific content section within the publisher''s site such as sports, business etc. The API in this sub-section allows retrieving marketer performance statistics with breakdown by section with sections that are already blocked at the marketer or campaign level. Note: Sections with less than 1 click or less than 10 impressions will not show up in the results. Result Fields Metrics in metrics, metadata in a metadata object containing the following fields: Property Type Semantic id String Section Identifier. name String Section Name. publisherId String Identifiers of the publisher related to the section. publisherName String Name of the publisher related to the section. cpcAdjustment Number CPC adjustment bid of this section for campaign given by the campaignId parameter (optional). blockStatus Block status Blocking status of the section. blockTypes Block types Block types and their value for the section. publisherUrl String URL of this section''s publisher (optional). isOen Boolean Is this an OEN (Outbrain Extended Network) section. (Planned removal October 18th)' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request. Used with offset for pagination. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: sort in: query required: false schema: type: string description: Can have one of the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, publisherName, name. For more details about reports filtering read this. example: -ctr - name: filter in: query required: false schema: type: string description: Can have the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, publisherId, publisherName, name. For more details about reports filtering read this. example: clicks+gt+99 - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: budgetId in: query required: false schema: type: string description: Limit to data of the budget with the given ID. example: adc4fc128ab0419ababf4b02153ee75f3c - name: campaignId in: query required: false schema: type: string description: Limit to data of the campaign with the given IDs (takes precedence over budgetId). example: e75f3cadc4fc128ab0419ababf4b02153e, 0069fc0fe9598f99b4c528f0881cd74b4b - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' - name: includeViewedImpressions in: query required: false schema: type: boolean description: When true, includes viewableImpressions in the response metrics. example: 'false' responses: '200': description: Successful response content: application/json: schema: type: object example: results: - metadata: id: 00553b4e7de013f31cf17b98e6e5c9a475 name: TIME publisherId: 006f78b958c0719b007fc916075c4d3449 publisherName: Time Magazine (Meredith) url: http://www.time.com/ blockStatus: Unblocked blockTypes: marketerPublisher: false marketerSection: false campaignPublisher: false campaignSection: false oenOptOut: false publisherUrl: https://time.com isOen: false metrics: impressions: 411612 clicks: 1186 totalConversions: 44 conversions: 44 viewConversions: 0 spend: 424.8 ecpc: 0.36 ctr: 0.29 conversionRate: 3.71 viewConversionRate: 0 cpa: 9.65 totalCpa: 9.65 totalValue: 176 totalSumValue: 176 sumValue: 176 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 2.1 totalRoas: 2.2 - metadata: id: 009ccab152daff19c2f26990be7be1164b name: CNN World publisherId: 0048938c4af9641f2e04565be89ece5954 publisherName: CNN (Turner U.S.) url: http://www.cnn.com/world blockStatus: Blocked blockTypes: marketerPublisher: false marketerSection: true campaignPublisher: false campaignSection: true oenOptOut: false publisherUrl: https://www.cnn.com isOen: false metrics: impressions: 337718 clicks: 602 totalConversions: 17 conversions: 17 viewConversions: 0 spend: 237.64 ecpc: 0.39 ctr: 0.18 conversionRate: 2.82 viewConversionRate: 0 cpa: 13.98 totalCpa: 13.98 totalValue: 68 totalSumValue: 68 sumValue: 68 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.8 totalRoas: 0.9 totalResults: 4874 summary: impressions: 17353421 clicks: 19258 totalConversions: 608 conversions: 608 viewConversions: 0 spend: 6320.31 ecpc: 0.33 ctr: 0.11 conversionRate: 3.16 viewConversionRate: 0 cpa: 10.4 totalCpa: 10.4 totalValue: 2420 totalSumValue: 2420 sumValue: 2420 viewSumValue: 0 totalAverageValue: 3.98 averageValue: 3.98 viewAverageValue: 0 roas: 0.9 totalRoas: 0.9 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/campaigns/sections: get: operationId: getReportsMarketersIdCampaignsSections summary: Retrieve performance statistics for all marketer campaigns by section description: 'A special endpoint for retrieving sections data by campaign breakdown. Note: The response structure defers from other performance responses. Note 2: Sections with less than 1 click or less than 10 impressions will not show up in the results. The reponse contains only campaigns that have sections results given the offset and limit, in the following two objects: Property Type Semantic campaignResults Array Results for the marketer campaigns. Each object in the array contains results and totalResults field similar to the response of the Sections request (except for the cpcAdjustment, blockStatus and blockTypes fields in the metadata field of each result), and an additional campaignId field with the campaign ID. totalCampaigns Number Count of the total campaigns in the campaignResults array.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each campaign. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: campaignResults: - campaignId: 000676cb2c84f64c5152822eb27af11d7e results: - metadata: id: 008a88410d1345570c09e0e58e07dbf859 name: Microsoft One Promo - EN-CA - MSN publisherId: 006c8be9b36b8208ac4ce41072cc5f59e3 publisherName: Microsoft One Promo Canada_EN (Microsoft One Promo) url: http://www.microsoft.onepromo.com/en-ca/msn/ publisherUrl: https://www.microsoft.com isOen: false metrics: impressions: 93744 clicks: 177 totalConversions: 1 conversions: 1 viewConversions: 0 spend: 38.77 ecpc: 0.22 ctr: 0.19 conversionRate: 0.56 viewConversionRate: 0 cpa: 38.77 totalCpa: 38.77 totalValue: 4 totalSumValue: 4 sumValue: 4 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.8 totalRoas: 0.8 conversionMetrics: - name: Install totalConversions: 1 conversions: 1 viewConversions: 0 conversionRate: 0.56 viewConversionRate: 0 totalCpa: 38.77 cpa: 38.77 totalValue: 4 totalSumValue: 4 sumValue: 4 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 - name: ArticleEngagement totalConversions: 2 conversions: 0 viewConversions: 2 conversionRate: 0 viewConversionRate: 0 totalCpa: 19.39 cpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 00ff7afb321062ac4221d0c6c935ec7788 name: CNN Edition - Politics publisherId: 007d5bdae84ea9f865307ba5e95aa29dda publisherName: CNN Edition (Turner International) url: http://edition.cnn.com/politics/ publisherUrl: http://edition.cnn.com isOen: false metrics: impressions: 83947 clicks: 109 totalConversions: 8 conversions: 8 viewConversions: 0 spend: 23.77 ecpc: 0.22 ctr: 0.13 conversionRate: 7.34 viewConversionRate: 0 cpa: 2.97 totalCpa: 2.97 totalValue: 32 totalSumValue: 32 sumValue: 32 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 conversionMetrics: - name: Install totalConversions: 8 conversions: 8 viewConversions: 0 conversionRate: 7.34 viewConversionRate: 0 totalCpa: 2.97 cpa: 2.97 totalValue: 32 totalSumValue: 32 sumValue: 32 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 - name: ArticleEngagement totalConversions: 6 conversions: 6 viewConversions: 0 conversionRate: 5.5 viewConversionRate: 0 totalCpa: 3.96 cpa: 3.96 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: MobileSignup totalConversions: 1 conversions: 1 viewConversions: 0 conversionRate: 0.92 viewConversionRate: 0 totalCpa: 23.77 cpa: 23.77 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 3781 - campaignId: 008cf1e9b1e1394b15f24aec493d2f861c results: - metadata: id: 00553b4e7de013f31cf17b98e6e5c9a475 name: TIME publisherId: 006f78b958c0719b007fc916075c4d3449 publisherName: Time Magazine (Meredith) url: http://www.time.com/ publisherUrl: https://time.com isOen: false metrics: impressions: 295134 clicks: 1036 totalConversions: 37 conversions: 37 viewConversions: 0 spend: 332.14 ecpc: 0.32 ctr: 0.35 conversionRate: 3.57 viewConversionRate: 0 cpa: 8.98 totalCpa: 8.98 totalValue: 148 totalSumValue: 148 sumValue: 148 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 conversionMetrics: - name: Install totalConversions: 37 conversions: 37 viewConversions: 0 conversionRate: 3.57 viewConversionRate: 0 totalCpa: 8.98 cpa: 8.98 totalValue: 148 totalSumValue: 148 sumValue: 148 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 - name: ArticleEngagement totalConversions: 100 conversions: 99 viewConversions: 1 conversionRate: 9.56 viewConversionRate: 0 totalCpa: 3.32 cpa: 3.35 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: MobileSignup totalConversions: 24 conversions: 24 viewConversions: 0 conversionRate: 2.32 viewConversionRate: 0 totalCpa: 13.84 cpa: 13.84 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 009ccab152daff19c2f26990be7be1164b name: CNN World publisherId: 0048938c4af9641f2e04565be89ece5954 publisherName: CNN (Turner U.S.) url: http://www.cnn.com/world publisherUrl: https://www.cnn.com isOen: false metrics: impressions: 196995 clicks: 472 totalConversions: 14 conversions: 14 viewConversions: 0 spend: 152.33 ecpc: 0.32 ctr: 0.24 conversionRate: 2.97 viewConversionRate: 0 cpa: 10.88 totalCpa: 10.88 totalValue: 56 totalSumValue: 56 sumValue: 56 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 conversionMetrics: - name: Install totalConversions: 14 conversions: 14 viewConversions: 0 conversionRate: 2.97 viewConversionRate: 0 totalCpa: 10.88 cpa: 10.88 totalValue: 56 totalSumValue: 56 sumValue: 56 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 - name: ArticleEngagement totalConversions: 31 conversions: 31 viewConversions: 0 conversionRate: 6.57 viewConversionRate: 0 totalCpa: 4.91 cpa: 4.91 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: MobileSignup totalConversions: 4 conversions: 4 viewConversions: 0 conversionRate: 0.85 viewConversionRate: 0 totalCpa: 38.08 cpa: 38.08 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 3405 - campaignId: 007100e5e10d8d937cb0a6a6efd7a5dd46 results: - metadata: id: 002eb98f6f1dee966af96f21d52d62df0b name: CNN International - US publisherId: 007d5bdae84ea9f865307ba5e95aa29dda publisherName: CNN Edition (Turner International) url: http://edition.cnn.com/us/ publisherUrl: http://edition.cnn.com isOen: false metrics: impressions: 150969 clicks: 252 totalConversions: 10 conversions: 10 viewConversions: 0 spend: 144.6 ecpc: 0.57 ctr: 0.17 conversionRate: 3.97 viewConversionRate: 0 cpa: 14.46 totalCpa: 14.46 totalValue: 40 totalSumValue: 40 sumValue: 40 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 conversionMetrics: - name: Install totalConversions: 10 conversions: 10 viewConversions: 0 conversionRate: 3.97 viewConversionRate: 0 totalCpa: 14.46 cpa: 14.46 totalValue: 40 totalSumValue: 40 sumValue: 40 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 - name: ArticleEngagement totalConversions: 16 conversions: 15 viewConversions: 1 conversionRate: 5.95 viewConversionRate: 0 totalCpa: 9.04 cpa: 9.64 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: MobileSignup totalConversions: 9 conversions: 9 viewConversions: 0 conversionRate: 3.57 viewConversionRate: 0 totalCpa: 16.07 cpa: 16.07 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 004bf8173c11726f62d6d12dd832b5e570 name: Aviation publisherId: 007d5bdae84ea9f865307ba5e95aa29dda publisherName: CNN Edition (Turner International) url: http://edition.cnn.com/aviation publisherUrl: http://edition.cnn.com isOen: false metrics: impressions: 67621 clicks: 238 totalConversions: 14 conversions: 14 viewConversions: 0 spend: 134.69 ecpc: 0.57 ctr: 0.35 conversionRate: 5.88 viewConversionRate: 0 cpa: 9.62 totalCpa: 9.62 totalValue: 56 totalSumValue: 56 sumValue: 56 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 conversionMetrics: - name: Install totalConversions: 14 conversions: 14 viewConversions: 0 conversionRate: 5.88 viewConversionRate: 0 totalCpa: 9.62 cpa: 9.62 totalValue: 56 totalSumValue: 56 sumValue: 56 viewSumValue: 0 totalAverageValue: 4 averageValue: 4 viewAverageValue: 0 roas: 0.5 totalRoas: 0.5 - name: ArticleEngagement totalConversions: 21 conversions: 21 viewConversions: 0 conversionRate: 8.82 viewConversionRate: 0 totalCpa: 6.41 cpa: 6.41 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: MobileSignup totalConversions: 5 conversions: 5 viewConversions: 0 conversionRate: 2.1 viewConversionRate: 0 totalCpa: 26.94 cpa: 26.94 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 3385 totalCampaigns: 3 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/sections/date: get: operationId: getReportsMarketersIdSectionsDate summary: Retrieve performance statistics for all marketer sections by dates description: 'Endpoint for retrieving sections data by date in a daily breakdown. Note: The response structure defers from other performance responses. Note2: Sections with less than 1 click or less than 10 impressions will not show up in the results. Property Type Semantic results Array Results for the daily breakdown. Each object in the array contains date, sections and totalResults field similar to the response of the Sections request (except for the cpcAdjustment, blockStatus and blockTypes fields in the metadata field of each result). total Number Count of the total sections in the results array. The returned values will be only the paginated data according the the offset and limit inputs.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each date. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: results: - date: '2023-06-21' sections: - metadata: id: 00fce4c29b9efd19ab3aef4c539204817f name: Fin24 (news24) publisherId: 00f368c60c3e20414baf560d4576489955 publisherName: news24 (24.com) url: http://www.news24.com/fin24 publisherUrl: http://www.news24.com/ metrics: impressions: 92879.0 clicks: 218.0 totalConversions: 2.0 conversions: 2.0 viewConversions: 0 spend: 18.42 ecpc: 0.084 ctr: 0.23 cpm: 0.2 conversionRate: 0.92 viewConversionRate: 0.0 cpa: 9.21 totalCpa: 9.21 totalSumValue: 9.0 sumValue: 9.0 viewSumValue: 0 totalAverageValue: 4.5 averageValue: 4.5 viewAverageValue: 0 totalRoas: 0.49 roas: 0.49 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 00a3787b76fe095b063997b3fd8821ffe4 name: snl24 - soccerladuma (DailySun) publisherId: 00aed6050e323fd1bbfb7427cfe7ec1608 publisherName: SNL24 (24.com) url: http://www.snl24.com/soccerladuma publisherUrl: http://www.dailysun.co.za/ metrics: impressions: 144444.0 clicks: 116.0 totalConversions: 2.0 conversions: 2.0 viewConversions: 0 spend: 9.27 ecpc: 0.08 ctr: 0.08 cpm: 0.06 conversionRate: 1.72 viewConversionRate: 0.0 cpa: 4.63 totalCpa: 4.63 totalSumValue: 9.0 sumValue: 9.0 viewSumValue: 0 totalAverageValue: 4.5 averageValue: 4.5 viewAverageValue: 0 totalRoas: 0.97 roas: 0.97 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 00e5b046c21aba12b954a2b71a8c2843a9 name: Sport24 (news24) publisherId: 00f368c60c3e20414baf560d4576489955 publisherName: news24 (24.com) url: http://www.news24.com/sport publisherUrl: http://www.news24.com/ metrics: impressions: 51207.0 clicks: 106.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 8.32 ecpc: 0.078 ctr: 0.21 cpm: 0.16 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 0055fb9caadc9052105d4998d517b2c9e0 name: Citypress24 (news24) publisherId: 00f368c60c3e20414baf560d4576489955 publisherName: news24 (24.com) url: http://www.news24.com/citypress publisherUrl: http://www.news24.com/ metrics: impressions: 30804.0 clicks: 61.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 6.38 ecpc: 0.105 ctr: 0.2 cpm: 0.21 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 0091e3b6729bf85f96b1a615b0a511c789 name: MSN - EN-US - Other Catchall - PREMIUM Header Bidd publisherId: 00929583c2306196c8b1a5ccf2c79e6621 publisherName: MSN US (PREMIUM Header Bidding) url: http://oen.oen.oen/?integration_id=32288&publisher=msn.com%2Fen-us%2Fcatchall&source=msn publisherUrl: http://msn.com/en-us/test/ metrics: impressions: 8502.0 clicks: 41.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 5.93 ecpc: 0.145 ctr: 0.48 cpm: 0.7 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 0012796e26017933ff2dc481d9c429de4c name: snl24 - kickoff (DailySun) publisherId: 00aed6050e323fd1bbfb7427cfe7ec1608 publisherName: SNL24 (24.com) url: http://www.snl24.com/kickoff publisherUrl: http://www.dailysun.co.za/ metrics: impressions: 53110.0 clicks: 53.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 3.99 ecpc: 0.075 ctr: 0.1 cpm: 0.08 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 008feb30c0167bff2dc2d00a4cc123cb2d name: You24 (news24) publisherId: 00f368c60c3e20414baf560d4576489955 publisherName: news24 (24.com) url: http://www.news24.com/you publisherUrl: http://www.news24.com/ metrics: impressions: 15158.0 clicks: 37.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 3.32 ecpc: 0.09 ctr: 0.24 cpm: 0.22 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 006e65baa7f9da011d529edf818986b816 name: Lottery24 (news24) publisherId: 00f368c60c3e20414baf560d4576489955 publisherName: news24 (24.com) url: http://www.news24.com/news24/lottery publisherUrl: http://www.news24.com/ metrics: impressions: 22064.0 clicks: 38.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 2.81 ecpc: 0.074 ctr: 0.17 cpm: 0.13 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 00ce309983bdd8f4c4cd15395668eae8dd name: Jacarandafm.com/news publisherId: 00df1691ec3deaf4ebde4959010a2fb8c0 publisherName: jacarandafm (Kagiso Media SA) url: http://www.jacarandafm.com/news/ publisherUrl: http://jacarandafm.com/ metrics: impressions: 17441.0 clicks: 27.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 2.36 ecpc: 0.087 ctr: 0.15 cpm: 0.14 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 0071458562de0156429b64c197c173ba1a name: Jacarandafm.com publisherId: 00df1691ec3deaf4ebde4959010a2fb8c0 publisherName: jacarandafm (Kagiso Media SA) url: http://www.jacarandafm.com/ publisherUrl: http://jacarandafm.com/ metrics: impressions: 3826.0 clicks: 9.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 2.06 ecpc: 0.229 ctr: 0.24 cpm: 0.54 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 totalResults: 63 - date: '2023-06-22' sections: - metadata: id: 00fce4c29b9efd19ab3aef4c539204817f name: Fin24 (news24) publisherId: 00f368c60c3e20414baf560d4576489955 publisherName: news24 (24.com) url: http://www.news24.com/fin24 publisherUrl: http://www.news24.com/ metrics: impressions: 124001.0 clicks: 344.0 totalConversions: 4.0 conversions: 4.0 viewConversions: 0 spend: 28.82 ecpc: 0.084 ctr: 0.28 cpm: 0.23 conversionRate: 1.16 viewConversionRate: 0.0 cpa: 7.2 totalCpa: 7.2 totalSumValue: 18.0 sumValue: 18.0 viewSumValue: 0 totalAverageValue: 4.5 averageValue: 4.5 viewAverageValue: 0 totalRoas: 0.62 roas: 0.62 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 0055fb9caadc9052105d4998d517b2c9e0 name: Citypress24 (news24) publisherId: 00f368c60c3e20414baf560d4576489955 publisherName: news24 (24.com) url: http://www.news24.com/citypress publisherUrl: http://www.news24.com/ metrics: impressions: 54793.0 clicks: 135.0 totalConversions: 4.0 conversions: 4.0 viewConversions: 0 spend: 10.61 ecpc: 0.079 ctr: 0.25 cpm: 0.19 conversionRate: 2.96 viewConversionRate: 0.0 cpa: 2.65 totalCpa: 2.65 totalSumValue: 18.0 sumValue: 18.0 viewSumValue: 0 totalAverageValue: 4.5 averageValue: 4.5 viewAverageValue: 0 totalRoas: 1.7 roas: 1.7 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 00a3787b76fe095b063997b3fd8821ffe4 name: snl24 - soccerladuma (DailySun) publisherId: 00aed6050e323fd1bbfb7427cfe7ec1608 publisherName: SNL24 (24.com) url: http://www.snl24.com/soccerladuma publisherUrl: http://www.dailysun.co.za/ metrics: impressions: 137567.0 clicks: 114.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 8.1 ecpc: 0.071 ctr: 0.08 cpm: 0.06 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 0091e3b6729bf85f96b1a615b0a511c789 name: MSN - EN-US - Other Catchall - PREMIUM Header Bidd publisherId: 00929583c2306196c8b1a5ccf2c79e6621 publisherName: MSN US (PREMIUM Header Bidding) url: http://oen.oen.oen/?integration_id=32288&publisher=msn.com%2Fen-us%2Fcatchall&source=msn publisherUrl: http://msn.com/en-us/test/ metrics: impressions: 7887.0 clicks: 35.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 7.91 ecpc: 0.226 ctr: 0.44 cpm: 1.0 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 00e5b046c21aba12b954a2b71a8c2843a9 name: Sport24 (news24) publisherId: 00f368c60c3e20414baf560d4576489955 publisherName: news24 (24.com) url: http://www.news24.com/sport publisherUrl: http://www.news24.com/ metrics: impressions: 49767.0 clicks: 91.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 6.83 ecpc: 0.075 ctr: 0.18 cpm: 0.14 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 00a336bb7fdbd0b2d15c37008bbb5c20a9 name: Opinions24 (news24) publisherId: 00f368c60c3e20414baf560d4576489955 publisherName: news24 (24.com) url: http://www.news24.com/news24/opinions publisherUrl: http://www.news24.com/ metrics: impressions: 23846.0 clicks: 65.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 4.72 ecpc: 0.073 ctr: 0.27 cpm: 0.2 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 0012796e26017933ff2dc481d9c429de4c name: snl24 - kickoff (DailySun) publisherId: 00aed6050e323fd1bbfb7427cfe7ec1608 publisherName: SNL24 (24.com) url: http://www.snl24.com/kickoff publisherUrl: http://www.dailysun.co.za/ metrics: impressions: 72512.0 clicks: 54.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 3.74 ecpc: 0.069 ctr: 0.07 cpm: 0.05 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 008feb30c0167bff2dc2d00a4cc123cb2d name: You24 (news24) publisherId: 00f368c60c3e20414baf560d4576489955 publisherName: news24 (24.com) url: http://www.news24.com/you publisherUrl: http://www.news24.com/ metrics: impressions: 13217.0 clicks: 25.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 2.77 ecpc: 0.111 ctr: 0.19 cpm: 0.21 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 003106635a5214e1fcf13503d337fbf662 name: MSN - EN-ZA - News - Galleries publisherId: 0062fd5d57f47577b449b9588dd08c2928 publisherName: MSN South Africa (MSN Intl) url: http://www.msn.com/en-za/news/galleryPage publisherUrl: https://www.msn.com/en-za metrics: impressions: 5421.0 clicks: 20.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 1.04 ecpc: 0.052 ctr: 0.37 cpm: 0.19 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 - metadata: id: 006e65baa7f9da011d529edf818986b816 name: Lottery24 (news24) publisherId: 00f368c60c3e20414baf560d4576489955 publisherName: news24 (24.com) url: http://www.news24.com/news24/lottery publisherUrl: http://www.news24.com/ metrics: impressions: 11461.0 clicks: 14.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 1.01 ecpc: 0.072 ctr: 0.12 cpm: 0.09 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0.0 roas: 0.0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 totalResults: 71 total: 2 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/sections/dateHourly: get: operationId: getReportsMarketersIdSectionsDateHourly summary: Retrieve performance statistics for all marketer sections by dates hourly description: 'Endpoint for retrieving sections data by date in a hourly breakdown (last 48 hours). Note: The response structure defers from other performance responses. Note2: Sections with less than 1 click or less than 10 impressions will not show up in the results. Property Type Semantic results Array Results for the daily breakdown. Each object in the array contains date, sections and totalResults field similar to the response of the Sections request (except for the cpcAdjustment, blockStatus and blockTypes fields in the metadata field of each result). total Number Count of the total sections in the results array. The returned values will be only the paginated data according the the offset and limit inputs.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: hours in: query required: false schema: type: number description: Number of hours, default is 24. Max allowed - 24. example: '24' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each date. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: results: - date: '2023-07-09 01:00:00' sections: - metadata: id: 0003378cafb6fef85579081ee3152f3929 name: MSN - EN-ZA - Edge Chromium New Tab - PREMIUM Header Bidding publisherId: 001786da67bd57e1fa88ddbd0c2b682ce6 publisherName: MSN South Africa (PREMIUM Header Bidding) url: http://oen.oen.oen/?integration_id=35383&publisher=msn.com%2Fen-za%2Fedgechrntp&source=msn publisherUrl: http://msn.com/en-za metrics: impressions: 0.0 clicks: 1.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.0 ecpc: 0.0 ctr: 0 cpm: 0 conversionRate: 0.0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 totalResults: 1 total: 1 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/sections/dateMinutely: get: operationId: getReportsMarketersIdSectionsDateMinutely summary: Retrieve performance statistics for all marketer sections by dates minutely description: 'Endpoint for retrieving sections data by date in a minutely breakdown (last 360 minutes). Note: The response structure defers from other performance responses. Note2: Sections with less than 1 click or less than 10 impressions will not show up in the results. Property Type Semantic results Array Results for the daily breakdown. Each object in the array contains date, sections and totalResults field similar to the response of the Sections request (except for the cpcAdjustment, blockStatus and blockTypes fields in the metadata field of each result). total Number Count of the total sections in the results array. The returned values will be only the paginated data according the the offset and limit inputs.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: minutes in: query required: false schema: type: number description: Number of minutes, default is 60 (Max 120) example: '60' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each date. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: results: - date: '2023-07-09 01:00:00' sections: - metadata: id: 0003378cafb6fef85579081ee3152f3929 name: MSN - EN-ZA - Edge Chromium New Tab - PREMIUM Header Bidding publisherId: 001786da67bd57e1fa88ddbd0c2b682ce6 publisherName: MSN South Africa (PREMIUM Header Bidding) url: http://oen.oen.oen/?integration_id=35383&publisher=msn.com%2Fen-za%2Fedgechrntp&source=msn publisherUrl: http://msn.com/en-za metrics: impressions: 0.0 clicks: 1.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0.0 ecpc: 0.0 ctr: 0 cpm: 0 conversionRate: 0.0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 totalRoas: 0 roas: 0 videoReachedFirstQ: 0 videoReachedSecondQ: 0 videoReachedThirdQ: 0 videoReachedCompletion: 0 videoViewDuration: 0 videoAvgViewDuration: 0.0 videoPlays: 0 clicksOnVideo: 0 videoActiveCompletions: 0 videoActiveCompletionsPercentage: 0 totalResults: 1 total: 1 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/platforms: get: operationId: getReportsMarketersIdPlatforms summary: Retrieve performance statistics for a Marketer by platform description: 'The API in this sub-section allows retrieving performance statistics by platform at different levels: marketer, budget, and campaign. Result fields Metrics in metrics, metadata in a metadata object containing the following fields: Property Type Semantic platform String The result platform, one of DESKTOP, TABLET or MOBILE. breakdown String The result breakdown, one of os, browser or platform for no breakdown. name String The result breakdown name when breakdown was requested. For example: Chrome for browser breakdown, MacOs for os breakdown. All possible options are available here: Operating System, Browser.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request. Used with offset for pagination. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: sort in: query required: false schema: type: string description: Can have one of the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, name, enabled, budgetStartDate, budgetEndDate and budgetAmount . For more details about reports filtering read this. example: -ctr - name: filter in: query required: false schema: type: string description: Can have the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, name, enabled, budgetStartDate, budgetEndDate, budgetAmount, budgetType, budgetShared and pacingType. For more details about reports filtering read this. example: clicks+gt+99 - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: budgetId in: query required: false schema: type: string description: Limit to data of the budget with the given ID. example: adc4fc128ab0419ababf4b02153ee75f3c - name: campaignId in: query required: false schema: type: string description: Limit to data of the campaign with the given IDs (takes precedence over budgetId). example: e75f3cadc4fc128ab0419ababf4b02153e, 0069fc0fe9598f99b4c528f0881cd74b4b - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'true' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' - name: breakdown in: query required: false schema: type: string description: Breakdown to apply, default platform. Allowed values are os, browser or platform for no breakdown. example: os - name: includeViewedImpressions in: query required: false schema: type: boolean description: When true, includes viewableImpressions in the response metrics. example: 'false' responses: '200': description: Successful response content: application/json: schema: type: object example: results: - metadata: platform: DESKTOP breakdown: browser name: InternetExplorer metrics: impressions: 4195073 clicks: 8152 totalConversions: 745 conversions: 230 viewConversions: 515 spend: 4030.80475451 ecpc: 0.49 ctr: 0.19 conversionRate: 2.82 viewConversionRate: 0.04 cpa: 17.53 totalCpa: 5.41 totalValue: 434.8 totalSumValue: 2184.5 sumValue: 434.8 viewSumValue: 1749.7 totalAverageValue: 2.93 averageValue: 1.89 viewAverageValue: 3.4 roas: 2.1 totalRoas: 2.1 - metadata: platform: MOBILE breakdown: browser name: InApp metrics: impressions: 6878520 clicks: 9682 totalConversions: 32 conversions: 32 viewConversions: 0 spend: 2823.38728532 ecpc: 0.29 ctr: 0.14 conversionRate: 0.33 viewConversionRate: 0 cpa: 88.23 totalCpa: 88.23 totalValue: 191.8 totalSumValue: 191.8 sumValue: 191.8 viewSumValue: 0 totalAverageValue: 5.99 averageValue: 5.99 viewAverageValue: 0 roas: 0.8 totalRoas: 0.8 totalResults: 27 summary: impressions: 30741217 clicks: 47185 totalConversions: 1567 conversions: 505 viewConversions: 1062 spend: 16557.76 ecpc: 0.35 ctr: 0.15 conversionRate: 1.07 viewConversionRate: 0 cpa: 32.79 totalCpa: 10.57 totalValue: 1545.5 totalSumValue: 5968.2 sumValue: 1545.5 viewSumValue: 4422.7 totalAverageValue: 3.81 averageValue: 3.06 viewAverageValue: 4.16 roas: 0.9 totalRoas: 0.9 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/campaigns/platforms: get: operationId: getReportsMarketersIdCampaignsPlatforms summary: Retrieve performance statistics for all marketer campaigns by platform description: 'A special endpoint for retrieving platforms data by campaign breakdown. Note: The response structure defers from other performance responses. The reponse contains only campaigns that have platforms results given the offset and limit, in the following two objects: Property Type Semantic campaignResults Array Results for the marketer campaigns. Each object in the array contains results and totalResults field similar to the response of the Platforms request, and an additional campaignId field with the campaign ID. totalCampaigns Number Count of the total campaigns in the campaignResults array.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each campaign. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' responses: '200': description: Successful response content: application/json: schema: type: object example: campaignResults: - campaignId: 00462de7a9940dbdb97fde336a1cc67375 results: - metadata: platform: MOBILE breakdown: platform metrics: impressions: 1719948 clicks: 1635 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 392.4152942308403 ecpc: 0.24 ctr: 0.1 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 1 - campaignId: 003a790efdabd72639941d114faf92e293 results: - metadata: platform: TABLET breakdown: platform metrics: impressions: 1020901 clicks: 978 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 488.9724015924813 ecpc: 0.5 ctr: 0.1 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: platform: DESKTOP breakdown: platform metrics: impressions: 2627062 clicks: 867 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 433.4989281392531 ecpc: 0.5 ctr: 0.03 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 2 totalCampaigns: 2 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/geo: get: operationId: getReportsMarketersIdGeo summary: Retrieve geo performance statistics for a Marketer description: 'The API in this sub-section allows retrieving performance statistics by geographic breakdown at different levels: country, region, and DMA. Result fields Metrics in metrics, metadata in a metadata object containing the following fields: Property Type Semantic id String Geo entity ID. name String Geo entity name. code String Geo entity code. locationsVersion String (Optional for region) The region''s inventory. V1 for FIPS and V2 for ISO-3166. countryId String (Optional for region, DMA or subregion) The country id of the specific region, DMA or subregion. countryName String (Optional for region, DMA or subregion) The country name of the specific region, DMA or subregion. countryCode String (Optional for region, DMA or subregion) The country code of the specific region, DMA or subregion. regionId String (Optional for subregion) The region id of the specific subregion. regionName String (Optional for subregion) The region name of the specific subregion. regionCode String (Optional for subregion) The region code of the specific subregion. Special request parameters Parameter Type Semantic Details breakdown String Defines the geo breakdown of data, either country, region, DMA or subregion. Mandatory' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request. Used with offset for pagination. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: sort in: query required: false schema: type: string description: Can have one of the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, name, code, countryName, countryCode, regionName and regionCode. For more details about reports sorting read this. example: -ctr - name: filter in: query required: false schema: type: string description: Can have the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, id, name, code, countryId, countryName countryCode, regionName and regionCode. For more details about reports filtering read this. example: clicks+gt+99 - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: budgetId in: query required: false schema: type: string description: Limit to data of the budget with the given ID. example: adc4fc128ab0419ababf4b02153ee75f3c - name: campaignId in: query required: false schema: type: string description: Limit to data of the campaign with the given IDs (takes precedence over budgetId). example: e75f3cadc4fc128ab0419ababf4b02153e, 0069fc0fe9598f99b4c528f0881cd74b4b - name: promotedLinkId in: query required: false schema: type: string - name: breakdown in: query required: true schema: type: string description: Defines the geo breakdown of data, either country, region, DMA, or subregion. example: region - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' - name: includeViewedImpressions in: query required: false schema: type: boolean description: When true, includes viewableImpressions in the response metrics. example: 'false' responses: '200': description: Successful response content: application/json: schema: type: object example: results: - metadata: id: 53584a380fecdfdfd93b9dfd754ea3d2 name: Sao Paulo code: '27' countryId: 281f981b8e4f56604268e52d8f50157e countryName: Brazil countryCode: BR metrics: impressions: 1525046 clicks: 5869 totalConversions: 20 conversions: 16 viewConversions: 4 spend: 1023.74 ecpc: 0.17 ctr: 0.38 conversionRate: 0.27 viewConversionRate: 0 cpa: 63.98 totalCpa: 51.19 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 conversionMetrics: - name: Signup totalConversions: 18 conversions: 14 viewConversions: 4 conversionRate: 0.24 viewConversionRate: 0 totalCpa: 56.87 cpa: 73.12 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: Install totalConversions: 2 conversions: 2 viewConversions: 0 conversionRate: 0.03 viewConversionRate: 0 totalCpa: 511.87 cpa: 511.87 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: af83c9abacffe72d11cfb39e1289ba5b name: Rio de Janeiro code: '21' countryId: 281f981b8e4f56604268e52d8f50157e countryName: Brazil countryCode: BR metrics: impressions: 432929 clicks: 2288 totalConversions: 2 conversions: 2 viewConversions: 0 spend: 356.39 ecpc: 0.16 ctr: 0.53 conversionRate: 0.09 viewConversionRate: 0 cpa: 178.2 totalCpa: 178.2 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 conversionMetrics: - name: Signup totalConversions: 1 conversions: 1 viewConversions: 0 conversionRate: 0.04 viewConversionRate: 0 totalCpa: 356.39 cpa: 356.39 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: Install totalConversions: 1 conversions: 1 viewConversions: 0 conversionRate: 0.04 viewConversionRate: 0 totalCpa: 356.39 cpa: 356.39 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 4bb922093812a7e196448e1639627696 name: Minas Gerais code: '15' countryId: 281f981b8e4f56604268e52d8f50157e countryName: Brazil countryCode: BR metrics: impressions: 356716 clicks: 1432 totalConversions: 7 conversions: 7 viewConversions: 0 spend: 237.15 ecpc: 0.17 ctr: 0.4 conversionRate: 0.49 viewConversionRate: 0 cpa: 33.88 totalCpa: 33.88 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 conversionMetrics: - name: Signup totalConversions: 7 conversions: 7 viewConversions: 0 conversionRate: 0.49 viewConversionRate: 0 totalCpa: 33.88 cpa: 33.88 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: ed1317a539fa60d3d1b23edc5c212a68 name: Parana code: '18' countryId: 281f981b8e4f56604268e52d8f50157e countryName: Brazil countryCode: BR metrics: impressions: 309395 clicks: 858 totalConversions: 2 conversions: 2 viewConversions: 0 spend: 145.35 ecpc: 0.17 ctr: 0.28 conversionRate: 0.23 viewConversionRate: 0 cpa: 72.68 totalCpa: 72.68 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 conversionMetrics: - name: Signup totalConversions: 1 conversions: 1 viewConversions: 0 conversionRate: 0.12 viewConversionRate: 0 totalCpa: 145.35 cpa: 145.35 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: Install totalConversions: 1 conversions: 1 viewConversions: 0 conversionRate: 0.12 viewConversionRate: 0 totalCpa: 145.35 cpa: 145.35 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: ee2efd3f07f0fdd3abbf917359881791 name: Rio Grande do Sul code: '23' countryId: 281f981b8e4f56604268e52d8f50157e countryName: Brazil countryCode: BR metrics: impressions: 294533 clicks: 774 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 129.25 ecpc: 0.17 ctr: 0.26 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 36 summary: impressions: 4196862 clicks: 15499 totalConversions: 39 conversions: 35 viewConversions: 4 spend: 2618.33 ecpc: 0.17 ctr: 0.37 conversionRate: 0.23 viewConversionRate: 0 cpa: 74.81 totalCpa: 67.14 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 conversionMetrics: - name: Signup totalConversions: 35 conversions: 31 viewConversions: 4 conversionRate: 0.2 viewConversionRate: 0 totalCpa: 74.81 cpa: 84.46 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - name: Install totalConversions: 4 conversions: 4 viewConversions: 0 conversionRate: 0.03 viewConversionRate: 0 totalCpa: 654.58 cpa: 654.58 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/campaigns/geo: get: operationId: getReportsMarketersIdCampaignsGeo summary: Retrieve performance statistics for all marketer campaigns by geo description: 'A special endpoint for retrieving geo data by campaign breakdown. Note: The response structure defers from other performance responses. The reponse contains only campaigns that have geo results given the offset and limit, in the following two objects: Property Type Semantic campaignResults Array Results for the marketer campaigns. Each object in the array contains results and totalResults field similar to the response of the Geo request, and an additional campaignId field with the campaign ID. totalCampaigns Number Count of the total campaigns in the campaignResults array. Special request parameters Parameter Type Semantic Details breakdown String Defines the geo breakdown of data, either country, region or DMA. Mandatory' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request for each campaign. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'false' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' - name: breakdown in: query required: true schema: type: string description: Defines the geo breakdown of data, either country, region or DMA. example: region responses: '200': description: Successful response content: application/json: schema: type: object example: campaignResults: - campaignId: 0036dfd487d1ec2b80094ba93cb9cfc86a results: - metadata: id: fc4deb5112fb4415a9edacdf4aafb0d8 name: United States code: US metrics: impressions: 13 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 4b90a812044fa1a76b265b916218fb04 name: Israel code: IL metrics: impressions: 191 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 281f981b8e4f56604268e52d8f50157e name: Brazil code: BR metrics: impressions: 1141826 clicks: 10618 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 1388.14 ecpc: 0.13 ctr: 0.93 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 3 - campaignId: 005a31a55e4fd8ccece20433d61cd78419 results: - metadata: id: fc4deb5112fb4415a9edacdf4aafb0d8 name: United States code: US metrics: impressions: 30 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 4b90a812044fa1a76b265b916218fb04 name: Israel code: IL metrics: impressions: 5 clicks: 0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 0 ecpc: 0 ctr: 0 conversionRate: 0 viewConversionRate: 0 cpa: 0 totalCpa: 0 totalValue: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 3 totalCampaigns: 2 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' /reports/marketers/{id}/interests: get: operationId: getReportsMarketersIdInterests summary: Retrieve performance statistics for a Marketer by interest description: 'The API in this sub-section allows retrieving performance statistics by interest at different levels: marketer and campaign. In all other performance reporting endpoints each user action (impression, click or conversion) is attributed to a single entity, for example campaign, section or region. Interests behave differently, since users can have multiple interests in their Outbrain Interest Profile and therefore data repeats between interests. For example, a user may be interested in both health and politics and so an impression, click or conversion will be attributed to both interests. As a result, the sum of the total interests reported does not represent the actual sum of action taken. Therefore, the summary and summaryFiltered metrics are not included in the response of interest performance reports. Result fields Metrics in metrics, metadata in a metadata object containing the following fields: Property Type Semantic id String Interest id. name String The name of the interest. Interests with hierarchy are given with a ''>'' symbol separating the interests level, for example ''News > Weather''. targetingStatus String The targeting status of the interest, one of targeted, excluded, notTargeted, partiallyTargeted or partiallyExcluded.' tags: - Performance Reporting parameters: - name: id in: path required: true schema: type: string description: Marketer id example: abf4b02153ee75f3cadc4fc128ab0419ab - name: from in: query required: true schema: type: string description: Start day Date example: '2015-12-22' - name: to in: query required: true schema: type: string description: End day Date example: '2016-01-20' - name: limit in: query required: false schema: type: number description: Number of results to return in this request. Used with offset for pagination. default is 10. example: '10' - name: offset in: query required: false schema: type: number description: Result number to start this response at. zero based. Used with limit for pagination. default is 0. example: '3' - name: sort in: query required: false schema: type: string description: Can have one of the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, name, enabled, budgetStartDate, budgetEndDate and budgetAmount . For more details about reports filtering read this. example: -ctr - name: filter in: query required: false schema: type: string description: Can have the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, name, enabled, budgetStartDate, budgetEndDate, budgetAmount, budgetType, budgetShared and pacingType. For more details about reports filtering read this. example: clicks+gt+99 - name: includeArchivedCampaigns in: query required: false schema: type: boolean description: Include data of archived campaigns, default false. example: 'true' - name: campaignId in: query required: false schema: type: string description: Limit to data of the campaign with the given IDs (takes precedence over budgetId). example: e75f3cadc4fc128ab0419ababf4b02153e, 0069fc0fe9598f99b4c528f0881cd74b4b - name: includeConversionDetails in: query required: false schema: type: boolean description: Include metrics of conversion pixels, default false. example: 'true' - name: conversionsByClickDate in: query required: false schema: type: boolean description: Report conversion metrics by click or conversion date, default false (report by conversion date). example: 'true' - name: includeViewedImpressions in: query required: false schema: type: boolean description: When true, includes viewableImpressions in the response metrics. example: 'false' responses: '200': description: Successful response content: application/json: schema: type: object example: results: - metadata: id: 003631f386d772d9f7238b4488219902bd name: News > Crime targetingStatus: partiallyTargeted metrics: impressions: 826217.0 clicks: 1412.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 505.67 ecpc: 0.358 ctr: 0.17 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 00692bb1cca92269ad4ae1f793a0aa77ac name: News > Politics targetingStatus: partiallyTargeted metrics: impressions: 688402.0 clicks: 1290.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 477.35 ecpc: 0.37 ctr: 0.19 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 0010166418d4411121a456060c1f5a0409 name: Entertainment > Celebrities targetingStatus: partiallyTargeted metrics: impressions: 668404.0 clicks: 1155.0 totalConversions: 2.0 conversions: 2.0 viewConversions: 0 spend: 388.04 ecpc: 0.336 ctr: 0.17 conversionRate: 0.17 viewConversionRate: 0.0 cpa: 194.02 totalCpa: 194.02 totalSumValue: 0.0 sumValue: 0.0 viewSumValue: 0 totalAverageValue: 0.0 averageValue: 0.0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 00d8f3272967167ad8680c4f8146f3c219 name: Business and Finance > Investing targetingStatus: partiallyTargeted metrics: impressions: 476384.0 clicks: 883.0 totalConversions: 2.0 conversions: 2.0 viewConversions: 0 spend: 347.2 ecpc: 0.393 ctr: 0.19 conversionRate: 0.23 viewConversionRate: 0.0 cpa: 173.6 totalCpa: 173.6 totalSumValue: 0.0 sumValue: 0.0 viewSumValue: 0 totalAverageValue: 0.0 averageValue: 0.0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 009abeb76ff3c21bb0d677fd0a847cae05 name: Sports > Soccer targetingStatus: partiallyTargeted metrics: impressions: 347335.0 clicks: 610.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 228.7 ecpc: 0.375 ctr: 0.18 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 00a140e37c302d1a709db08f3910f38b09 name: Health > Misc targetingStatus: partiallyTargeted metrics: impressions: 287858.0 clicks: 503.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 183.77 ecpc: 0.365 ctr: 0.17 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 005319b9ead9e283cfd29faeb00927b633 name: Entertainment > Television targetingStatus: partiallyTargeted metrics: impressions: 362599.0 clicks: 470.0 totalConversions: 2.0 conversions: 2.0 viewConversions: 0 spend: 157.97 ecpc: 0.336 ctr: 0.13 conversionRate: 0.43 viewConversionRate: 0.0 cpa: 78.98 totalCpa: 78.98 totalSumValue: 0.0 sumValue: 0.0 viewSumValue: 0 totalAverageValue: 0.0 averageValue: 0.0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 00d709bbe37f5a73e491e38c61058accf5 name: Autos targetingStatus: notTargeted metrics: impressions: 180320.0 clicks: 374.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 141.43 ecpc: 0.378 ctr: 0.21 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 0020521be9bebc58de7f7f47693fb53f6e name: News > Weather targetingStatus: partiallyTargeted metrics: impressions: 167318.0 clicks: 253.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 91.14 ecpc: 0.36 ctr: 0.15 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 - metadata: id: 00a429a651c8bf46e569183b284255bd4f name: Recreation > Dining targetingStatus: notTargeted metrics: impressions: 139877.0 clicks: 266.0 totalConversions: 0 conversions: 0 viewConversions: 0 spend: 91.03 ecpc: 0.342 ctr: 0.19 conversionRate: 0.0 viewConversionRate: 0.0 cpa: 0 totalCpa: 0 totalSumValue: 0 sumValue: 0 viewSumValue: 0 totalAverageValue: 0 averageValue: 0 viewAverageValue: 0 roas: 0 totalRoas: 0 totalResults: 105 headers: AMPLIFY-REQUEST-ID: description: Request correlation / rate-limit signal schema: type: string '400': description: Bad Request - the request could not be understood or was missing required parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - authentication failed or the user lacks permission for the requested operation content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden - access denied content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found - resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests - request exceeded rate limits; see the rate-limit-msec-left header content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Error: type: object description: Error envelope returned on 400/401/403/404/429 responses. properties: moreInfo: type: string description: Short machine-readable hint identifying the failing operation. errorMessage: type: string description: Human-readable error message. examples: - moreInfo: get-budget errorMessage: access denied securitySchemes: OBTokenAuth: type: apiKey in: header name: OB-TOKEN-V1 description: Token obtained from GET /login (HTTP Basic) or from https://my.outbrain.com/create-token. Valid for 30 days. BasicAuth: type: http scheme: basic description: HTTP Basic credentials used only on GET /login to obtain an OB-TOKEN-V1 token.