Reports by keywords¶

Parameters¶

HTTP method	Access rights	URL	Parameters	Note
GET	statistics	`https://api.admitad.com/statistics/keywords/`	offset limit date_start * date_end * website * campaign * source * total order_by ***	Statistical data on keywords.*

* Returns the result in the JSON format.

** Sets skipping and the number of records returned. For example limit=5&offset=2.

*** Filter by date, ad spaces, affiliate programs, and sources, respectively. For example campaign=3&campaign=4&website=8&date_start=01.01.2011, where the values are identifiers of filtered categories or filtered data. The values for dates should be in format ‘%d.%m.%Y’ - ‘01.05.2012’.

**** The parameter that allows to obtain aggregated data for the entire request. Possible values: 1/0 - aggregated data/not aggregated result

***** Sorting order. Possible values:

actions

clicks

cr

ecpc

keyword

leads

payment_sum

payment_sum_approved

payment_sum_declined

payment_sum_open

sales

Sign ‘-‘ before the value means inverse sort order. For example, order_by=-clicks&order_by=cr.

Example of use¶

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/statistics/keywords/?date_start=01.01.2011&limit=2&order_by=-payment_sum

Example of the response from the API server in the JSON format:

{
    "results": [
        {
            "leads_sum": 1,
            "keyword": "test",
            "currency": "EUR",
            "payment_sum_declined": 0.0,
            "payment_sum_open": 8.97,
            "payment_sum_approved": 0.0,
            "sales_sum": 0,
            "cr": 0.0,
            "ecpc": 1.794,
            "clicks": 5
        },
        {
            "leads_sum": 0,
            "keyword": "ept",
            "currency": "EUR",
            "payment_sum_declined": 0.0,
            "payment_sum_open": 0.0,
            "payment_sum_approved": 0.0,
            "sales_sum": 0,
            "cr": 0.0,
            "ecpc": 0.0,
            "clicks": 1
        }
    ],
    "_meta": {
        "count": 3,
        "limit": 2,
        "offset": 0
    }
}

Example of a request with utility ``curl``:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/statistics/keywords/?date_start=01.01.2011&limit=2&order_by=-payment_sum&total=1

Example of the response from the API server in the JSON format:

[
    {
        "leads_sum": 21594304,
        "payment_sum": 3382089.02,
        "views": 7337610,
        "payment_sum_declined": 1705783.09,
        "actions_sum_total": 22023257,
        "payment_sum_approved": 1646173.57,
        "currency": "RUB",
        "sales_sum": 21694727,
        "payment_sum_open": 1735915.45,
        "clicks": 7064253
    }
]

Description of API server response fields¶

Name	Description
keyword	Keyword
currency	System currencies
leads_sum	Number of leads
sales_sum	Number of sales
payment_sum_declined	The amount related to the rejected actions
payment_sum_approved	The amount related to the confirmed actions
payment_sum_open	The amount related to the actions on hold
clicks	The number of clicks
ecpc	eCPC
cr	Conversion rate