Skip to main content

Reporting API

To get reports over Campaigns there is CampaignReport GraphQL query. Reports are updated at hourly at 00:00 every hour. Numbers on ongoing campaigns are subject to be changed in any direction, in case Contimo detects Invalid Traffic. Reports does not include any events occured on the Preview pages.

Basic query​

query CampaignReport($startDate: Date!, $endDate: Date!, $filters: ReportFilter){
  report: CampaignReport(startDate: $startDate, endDate: $endDate, filters: $filters) {
    # dimensions
    websiteId
    
    # measures
    pageviews
    reads
    clicks
    payout
  }
}

You must specify startDate, endDate and optionally filters

{
  "startDate": "2023-06-01",
  "endDate": "2023-06-30",
  "filters": {
    "publisherId": "...."
  }
}

Reponse contains of array of objects with specified measures and dimensions

{
  "data": {
    "report": [
      { 
        "websiteId": "...",
        "pageviews": 10,
        "reads": 9,
        "clicks": 2,
        "payout": 50
      }
    ]
  }
}

Measures​

You can specify what numbers you want to get out. Here is the list for your disposal:

  • pageviews - total amount of pageviews registered
  • reads - total amount of pageview that met Contimo verified read criteria
  • clicks - total amount of clicks on links that has "conversion" attribute enabled
  • readtime - average page read time (seconds)
  • payout - how much publisher will earn on running this campaign
  • cost - how much advertiser will pay for this campaign

Dimensions​

You can slive your selected measures by any of these dimensions.

  • publisherId - Publisher ID
  • websiteId - Website ID
  • advertiserId - Advertiser ID
  • campaignId - Campaign ID
  • publicationId - Publication ID
  • date - Day of event (in CET timezone)
  • week - Week in a date format of a Monday starting the week
  • month - Month in a date format of a first day of the month

Choose dimensions, based on your use-case. For instance, if you need to figure out earnings per website, then you can use websiteId dimension.

If you need to get weekly campaigns performance use campaignId and week dimensions.

Filters​

Reporting API only provides you access to data you should see.

Campaign owners can see full performance and can access all websites where campaign was run.

Publisher who runs campaigns booked by Advertiser, can see only own "contribution" to the campaign performance.