Statistics

Retrieve the statistics of your applications

Get statistics

GET https://api.ogury.io/reporting/v1/stats

This endpoint allows you to get your statistics.

Query Parameters

Name	Type	Description
group_by	string	Get stats with aggregation. You can use up to 3 aggregations that can be : - application - country - ad_unit_id - fill_type - month (1) - week (1) - day (1) Example: month,country (1) You can only use one type of date aggregation at a time.
fill_type	string	Only one value accepted: "standard" or "premium". Default: all fill types Example: premium
ad_unit_ids	string	List of ad unit id for which the data is requested, separated by a comma. Default: all ad units Example: 299999_default,300000_default,02a37d50-6e44-0136-fdc8-0242ac120003
countries	string	List of countries for which the data is requested, separated by a comma. ISO 3166-1 alpha-2 Default: all countries Example: US,FR,IT
applications	string	List of applications app_key (see applications endpoint) for which data will be included in the response, separated by a comma. Default: all applications for the given publisher. Example: 1234,2345,3456
to_date	string	The end date of the timeframe for which the data is requested. This day is the last day included in the response. Format YYYY-MM-DD. Default: current day. Example: 2020-09-01 (2) Warning, periods can be adjusted automatically.
from_date	string	The starting date of the timeframe for which the data is requested. This day is the first day included in the response. Format YYYY-MM-DD. Default: 30 days before the current day. Example: 2020-10-01 (2) Warning, periods can be adjusted automatically. ​'from_date' and 'to_date' can be automatically changed in the following cases: - the requested period is too long (maximum of 90 days): the 'to_date' parameter is changed to reduce the period (= from_date +90 days). - 'from_date' is not corresponding to the first day of a week or a month when using week or month aggregation. - 'from_date' is changed to fit with the last day of the selected week or month. idem from 'to_date': the 'to_date' parameter can be moved back to fit the week or month period. - if 'to_date' is in the future, 'to_date' will be changed to correspond to the current day.

Headers

Name	Type	Description
x-auth-apikey	string	The API key
x-auth-secret	string	The API secret

200 curl -H 'Content-Type: application/json' -H 'x-auth-apikey: MY_API_KEY' -H 'x-auth-secret: MY_API_SECRET' 'https://api.ogury.io/reporting/v1/stats?from_date=2020-09-30&to_date=2020-10-02&group_by=day,ad_unit_id'

{
    "info": "Additionals information available here",
    "fromDate": "2020-09-30",
    "toDate": "2020-10-02",
    "applications": [
        12345,
        23456,
        34567
    ],
    "applicationInfos": [
        {
            "apiKey": 12345,
            "platform": "ANDROID"
        },
        {
            "apiKey": 23456,
            "platform": "iOS"
        },
        {
            "apiKey": 34567,
            "platform": "ANDROID"
        }
    ],
    "aggregationDescription": "day,ad_unit_id",
    "aggregation": {
        "2020-09-30": {
            "aggregation": {
                "12345_default": {
                    "stats": {
                        "impressions": 2488036,
                        "revenue": 28938.08,
                        "requests": 3510954,
                        "ecpm": 11.63
                    }
                },
                "23456_default": {
                    "stats": {
                        "impressions": 1306279,
                        "revenue": 14882.52,
                        "requests": 2092813,
                        "ecpm": 11.39
                    }
                }
            }
        },
        "2020-10-01": {
            "aggregation": {
                "12345_default": {
                    "stats": {
                        "impressions": 1355770,
                        "revenue": 13314.8,
                        "requests": 3648636,
                        "ecpm": 9.82
                    }
                },
                "23456_default": {
                    "stats": {
                        "impressions": 697663,
                        "revenue": 6632.94,
                        "requests": 1843377,
                        "ecpm": 9.51
                    }
                }
            }
        },
        "2020-10-02": {
            "aggregation": {
                "12345_default": {
                    "stats": {
                        "impressions": 336664,
                        "revenue": 3848.27,
                        "requests": 3942938,
                        "ecpm": 11.43
                    }
                },
                "23456_default": {
                    "stats": {
                        "impressions": 138516,
                        "revenue": 1596.62,
                        "requests": 1605168,
                        "ecpm": 11.53
                    }
                }
            }
        }
    }
}

400 Check the parameters, the field error can give you more details (see error code below)

// When giving a "to_date" parameter, the parameter "from_date" becomes mandatory
{"error":"ERROR_FROM_DATE_MANDATORY"}

// The parameter "from_date" must be set before to parameter "to_date"
{"error":"ERROR_FROM_DATE_AFTER_TO_DATE"}

// The parameter "from_date" has to be in format "YYYY-MM-DD"
{"error":"ERROR_INVALID_FROM_DATE_FORMAT"}

// The parameter "to_date" has to be in format "YYYY-MM-DD"
{"error":"ERROR_INVALID_TO_DATE_FORMAT"}

// Fill type has to be "standard" or "premium"
{"error":"ERROR_INVALID_FILL_TYPE"}

// You can use a maximum of 3 aggregations
{"error":"ERROR_TOO_MANY_AGGREGATIONS"}

// You can use only one date aggregation (day, week or month)
{"error":"ERROR_TOO_MANY_DATE_AGGREGATIONS"}

// The app key must be a numeric value
{"error": "ERROR_INVALID_APP_KEY"}

401 Check that the credentials (API key and secret) are still valid

{
  "timestamp": 1603730666689,
  "status": 401,
  "error": "Unauthorized",
  "message": "Access Denied",
  "path": "/v1/stats"
}  

404 The URL is incorrect

{
  "timestamp": 1604407287424,
  "status": 404,
  "error": "Not Found",
  "message": "No message available",
  "path": "/v1/statsx"
}

405 You should only use the GET method

{
  "timestamp": 1604407435802,
  "status": 405,
  "error": "Method Not Allowed",
  "exception": "org.springframework.web.HttpRequestMethodNotSupportedException",
  "message": "Request method 'POST' not supported",
  "path": "/v1/stats"
}

500 An unknown error occurred on the Ogury server

{
  "timestamp": 1604407103532,
  "status": 500,
  "error": "Internal Server Error",
  "exception": "java.lang.RuntimeException",
  "message": "org.springframework.web.client.ResourceAccessException: I/O error ...",
  "path": "/v1/stats"
}

Examples

Retrieve the statistics for the previous month to now

curl -H 'Content-Type: application/json' \
     -H 'x-auth-apikey: MY_API_KEY' \
     -H 'x-auth-secret: MY_API_SECRET' \
     'https://api.ogury.io/reporting/v1/stats?group_by=month'

Retrieve the statistics for a specific month

curl -H 'Content-Type: application/json' \
     -H 'x-auth-apikey: MY_API_KEY' \
     -H 'x-auth-secret: MY_API_SECRET' \
     'https://api.ogury.io/reporting/v1/stats?from_date=2020-09-01&to_date=2020-09-01&group_by=month'

For the group by month, the from_date is truncated to the beginning of the month and the to_date is set to the end of the month.

In this example, to_date is modified by 2020-09-30.

Retrieve the statistics by day, ad_unit_id, and country

curl -H 'Content-Type: application/json' \
     -H 'x-auth-apikey: MY_API_KEY' \
     -H 'x-auth-secret: MY_API_SECRET' \
     'https://api.ogury.io/reporting/v1/stats?from_date=2020-09-01&to_date=2020-09-30&group_by=day,ad_unit_id,country'

The application route gives you the details of your ad_unit.

If you want to re-group them by type, you can use the /applications to retrieve the details about the ad_unit and re-group them by application and ad_unit type.