Reporting API - Publisher Documentation

Owned by Laureen Violleau
Last updated: Nov 20, 2023 by Damien Trang
3 min read

Introduction

This document describes the Adyoulike Reporting API. The document aims at outlining the process to call the API, the authentication system and configuration, and the list of available dimensions and metrics.

Report period limit

Requests are limited to a maximum period of 90 days (start date/end date) for a single report.

Limits

This API is subject to a requests limit of 100 requests per client authorized per day. 

Access and authentication

Here is the link to access the Adyoulike Reporting API: https://stats-api-doc.omnitagjs.com/#/Stats/get_stats .

Please note the Reporting API requires an account on the DNA platform with reporting rights and requires a unique authentication token. To get your token, you need to contact your Adyoulike representative.

Once you received your token, you will need to add it in the “Authorize”section, and then click on “Try it out” to unlock the access, as follows:

Setup a report

Once the token has been added, you can start setting up your report.

Date and timezone

Start date: Add a start date (YYYYMMDD format). For instance, for a report starting on the 30th, October 2021, you will add 20211030 in the corresponding field.

End date: Add an end date as well (data will include this end date). The format is YYYYMMDD. For a reporting ending on the 6th, November 2021, you will add 20211106 in the corresponding field.

Metrics and dimensions

Metrics: Select the metrics you want to retrieve. Here is the list of metrics:

  • impression

  • video_impression

  • revenue

  • click

  • visible_impression

  • viewability_rate

Dimensions: If you want to group your stats by specific dimensions, here is the list:

  • placement_name: Name of the placement

  • placement_id: ID of the placement

  • site_name: Name of the site

  • country: Country code (iso 2 format) from which the impression originated

  • device: Type of device from which the impression originated

  • ad_kind_name: Ad kind from which the impression originated.

Filters

Filters can be added if you want to restrict your reports to a specific publisher.

Publisher ID: This allows you to filter your report on a specific publisher. If your company is both advertiser/publisher, fill it with the company uid to get the publisher view.

Realm Publisher ID: This allows you to filter your report on a specific realm publisher. If your company is both advertiser/publisher, fill it with the realm uid to get the publisher view. Please note this setting is only available for admins and super admins.

Pull out the report

Once the report has been set up, you can “Execute” the request, which will generate your report in the “Response body”. If needed, you can download the report and/or copy/paste the Curl response above.