Reports by ad spaces

Parameters

HTTP method

Access rights

URL

Parameters

Note

GET advertiser_statistics https://api.admitad.com/advertiser/{c_id}/statistics/websites/
  • offset**
  • limit**
  • start_date***
  • end_date***
  • webmasters***
  • websites***
  • groups***
  • channels***
  • actions***
  • order_by****

Statistical data on ad spaces where с_id is affiliate program ID.*

  • * Returns the result in the JSON format.

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

  • *** Filter by date, publishes, ad space, group, channel, and rate, respectively. For example websites=3&websites=4&groups=8&start_date=01.01.2011&end_date=11.01.2011, where values are the identifiers of filtered categories or filtered data. The values for dates must be in the format %d.%m.%Y - 01.05.2012.

  • **** Sorting order. Possible values:
    • clicks
    • cr
    • ctr
    • website_name
    • ecpc
    • ecpm
    • leads_approved
    • leads_declined
    • leads_open
    • new_rate
    • payment_sum_all
    • payment_sum_approved
    • payment_sum_declined
    • payment_sum_open
    • sales_approved
    • sales_declined
    • sales_open
    • views

    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/advertiser/1032/statistics/websites/?limit=2&start_date=29.09.2014&end_date=02.10.2014"

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

{
    "results": [
        {
            "sales_approved": "0",
            "sales_declined": "0",
            "payment_sum_approved": "0.00",
            "ctr": 0.0,
            "views": 0,
            "currency": "RUB",
            "leads_open": "147",
            "website_name": "",
            "payment_sum_open": "7170.00",
            "ecpm": 0.0,
            "payment_sum_declined": "0.00",
            "cr": 14.08,
            "leads_declined": "0",
            "sales_open": "0",
            "leads_approved": "0",
            "ecpc": 6.87,
            "clicks": 1044
        },
        {
            "sales_approved": "0",
            "sales_declined": "0",
            "payment_sum_approved": "0.00",
            "ctr": 0.0,
            "views": 0,
            "currency": "RUB",
            "leads_open": "110",
            "website_name": "",
            "payment_sum_open": "6072.00",
            "ecpm": 0.0,
            "payment_sum_declined": "0.00",
            "cr": 0.81,
            "leads_declined": "0",
            "sales_open": "0",
            "leads_approved": "0",
            "ecpc": 0.45,
            "clicks": 13532
        }
    ],
    "_meta": {
        "count": 123,
        "limit": 2,
        "offset": 0
    }
}

Description of API server response fields

Name

Description

clicks

Clicks

currency

Currency

cr

Conversion rate

ctr CTR
website_name

Ad space

ecpc eCPC
ecpm eCPM
leads_approved

Number of confirmed leads

leads_declined

Number of rejected leads

leads_open

Number of leads on hold

payment_sum_approved

The amount related to the confirmed actions

payment_sum_declined

The amount related to the rejected actions

payment_sum_open

The amount related to the actions on hold

sales_approved

Number of confirmed sales

sales_declined

Number of rejected sales

sales_open

Number of sales on hold

views

The number of impressions