Get Started with Avocarrot

Overview

Examples

Android

Overview

- Avocarrot Exchange SDK

Setup Exchange SDK

Stream

Interstitial

Native Assets

Exchange Troubleshooting

- Avocarrot Mediation SDK

Setup Mediation SDK

Stream Ads Mediation

Native Ads Mediation

Banner Mediation

Interstitial Mediation

Video Mediation

Supported Networks & Ad Types

Mediation Troubleshooting

iOS

Overview

- Avocarrot Exchange SDK

Setup SDK

Stream

Native Assets

Exchange Troubleshooting

- Avocarrot Mediation

Getting Started With Mediation

Stream Ads Mediation

Native Ads Mediation

Banner Ads Mediation

Interstitial Ads Mediation

Video Ads Mediation

Supported Networks & Ad Types

Mediation Troubleshooting

API Documentation

Reporting API

Help

FAQ

Updates

SDK Change Log

Reporting API

Updated 11 days ago ​by Chris

Overview

Reporting API allows Publishers to export their data from our platform and use them in their own custom dashboard or other 3rd Party tools.

Detailed documentation and interactive examples can be found here.

Prerequisites

In order to start using the API you will need the following:

  • Your unique id as a Publisher, from now on referred as publisher_id.

  • client_id and client_secret for your Client implementation.

You can go to https://ssp.avocarrot.com/apis/clients and click the new client to get your Client Id and Client Secret.

Setup Reporting API

With the current version v1.1 of the Reporting API all Publishers have access to the metrics that really matter for their revenue performance monitoring.
These metrics are:

  • Earnings
  • eCPM
  • Ad Requests
  • Impressions
  • Clicks
  • CTR

Given the above metrics there are 3 available dimensions that could be used to filter or group the results. This enables you to get the information in many different ways to match even your most demanding needs. These dimensions are:

  • App Id
  • Placement Key
  • Country

Moreover, specific date and time ranges can be used to filter the results as long as you group them in a granularity from day to hour.

Quick start

Example request with curl:

#!/bin/bash
curl -L -s \
-H 'Accept: application/json; charset=utf-8' \
https://reporting.avocarrot.com/v1.1/publishers/7214\?access_token\=asdfgdf92bfd67b15195\&granularity\=day

Response in JSON:

{
  "query": {
    "filters": {
      "publisher_id": [ "7214" ],
        "app_id": [],
        "placement_key": [],
        "country": []
    },
    "granularity": "day",
    "group": [ "publisher_id" ],
    "timestamp": {
      "from": "2016-04-12T00:00:00.000Z",
      "to": "2016-04-12T13:00:00.000Z"
    }
  },
  "data": [
    {
      "timestamp": "2016-04-12T00:00:00.000Z",
      "dimensions": {
        "app_id": null,
        "country": null,
        "placement_key": null,
        "publisher_id": "7214"
      },
      "result": {
        "ad_requests": 10000,
        "clicks": 250,
        "ctr": 0.10,
        "earnings": 2.0,
        "ecpm": 0.8,
        "impressions": 2500
      }
    }
  ],
  "meta": {
    "currency": "USD"
  }
}
 

For more details and code snippets visit our detailed reporting API docs.


Was this article useful?