Get Started with Avocarrot

Overview

Examples

Android

Overview

- Native Ads

List/Feed

Custom

- Standard IAB Formats

Banner

Interstitial

Video

- Others

Troubleshooting

Admob Android Adapter

Mopub Android Adapter

DFP Android Adapter

iOS

Overview

- Native Ads

List/Feed

Custom

- Standard IAB Formats

Banner

Interstitial

Video

- Others

Troubleshooting

- Adapters

Admob iOS Adapter

Mopub iOS Adapter

DFP iOS Adapter

API Documentation

Reporting API

Help

Supported Networks & Ad Types

General

Earnings

Payments and Accounting

Integration

Reporting

Mediation Network Optimization

Legal and Privacy

Updates

SDK Change Log

Android Change Log

iOS Change Log

Reporting API

Updated 15 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 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 create your client_id  and  client_secret by going to your Dashboard APIs tab and adding a new client.


                    

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 (float)
  • impressions (int)
  • eCPM (float)
  • ad_requests (int)
  • clicks (int)
  • ctr (float)
  • fill_rate (float)
  • render_rate (float)

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:

Main

  • publisher_id (string)
  • app_id (string)
  • app_version (string)
  • sdk_version (string)
  • adunit_id (string)
  • adunit_type (string)

Audience related

  • country (string)
  • city (string)
  • carrier (string)
  • connection_type (string)
  • device_os (string)
  • device_os_version (string)
  • device_brand (string)
  • device_model (string)
  • device_orientation (string)

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/18bceb98-3f11-481c-80fe-40531da40925\?access_token\=asdfgdf92bfd67b15195\&granularity\=day

Response in JSON:

{
  "query": {
    "filters": {
      "publisher_id": ["18bceb98-3f11-481c-80fe-40531da40925"],
      "app_id": [],
      "app_version": [],
      "adunit_id": [],
      "adunit_type": [],
      "country": [],
      "city": [],
      "sdk_version": [],
      "carrier": [],
      "connection_type": [],
      "device_os": [],
      "device_os_version": [],
      "device_brand": [],
      "device_model": [],
      "device_orientation": []
    },
    "granularity": "all",
    "timestamp": {
      "from": "2017-09-28T00:00:00.000Z",
      "to": "2017-09-28T09:00:00.000Z"
    },
    "group": ["publisher_id"]
  },
  "data": [{
    "timestamp": "2017-09-28T00:00:00.000Z",
    "dimensions": {
      "app_id": null,
      "app_version": null,
      "country": null,
      "city": null,
      "adunit_id": null,
      "adunit_type": null,
      "publisher_id": "18bceb98-3f11-481c-80fe-40531da40925",
      "sdk_version": null,
      "carrier": null,
      "connection_type": null,
      "device_os": null,
      "device_os_version": null,
      "device_brand": null,
      "device_model": null,
      "device_orientation": null
    },
    "result": {
      "ad_requests": 0,
      "clicks": 0,
      "ctr": 0,
      "earnings": 0,
      "ecpm": 0,
      "impressions": 0,
      "render_rate": 0,
      "fill_rate": 0
    }
  }],
  "meta": {
    "currency": "USD"
  }
}

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


Was this article useful?