Reports by actions

Parameters

HTTP method

Access rights

URL

Parameters

Note

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

Statistical data on actions where с_id is the 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, publisher, ad space, rate, group, channel, status, banner, payment ID, and system ID, 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:
    • action_all
    • cart
    • click_time
    • clicks
    • closing_date
    • conversion_time
    • cr
    • ctr
    • datetime
    • ecpc
    • ecpm
    • full_payment
    • id
    • leads_approved
    • leads_declined
    • leads_open
    • new_rate
    • order_id
    • payment
    • payment_sum_all
    • payment_sum_approved
    • payment_sum_approved
    • payment_sum_declined
    • payment_sum_declined
    • payment_sum_open
    • payment_sum_open
    • payment_sum_system_approved
    • payment_sum_system_declined
    • payment_sum_system_open
    • payment_to_system
    • product
    • sales_approved
    • sales_declined
    • sales_open
    • status
    • views
    • webmaster

    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/1/statistics/actions/?limit=2"

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

{
    "results": [
        {
            "order_sum": "1.00",
            "action_ip": "244.196.245.35",
            "uid": "1",
            "website_id": "site1_of_webmaster1",
            "currency": "RUB",
            "id": 455109,
            "click_time": "2014-10-03T17:23:17",
            "action_country": null,
            "click_ref": "",
            "order_id": "1",
            "payment_webmaster": "5000.00",
            "click_ip": "58.227.38.245",
            "action_id": 1,
            "status": 0,
            "full_payment": "5000.00",
            "screen": "",
            "action_name": "product1",
            "payment_system": "0.00",
            "conversion_time": 2,
            "click_country": null,
            "user_language": "",
            "webmaster": "webmaster1",
            "action_time": "2013-12-10T16:30:52",
            "tracking": "1",
            "closing_date": "2013-12-19",
            "user_agent": "django-test-client",
            "action_ref": ""
        },
        {
            "order_sum": "1.00",
            "action_ip": "251.166.164.253",
            "uid": "1",
            "website_id": "site1_of_webmaster1",
            "currency": "RUB",
            "id": 455110,
            "click_time": "2014-10-03T17:23:17",
            "action_country": null,
            "click_ref": "",
            "order_id": "1",
            "payment_webmaster": "5000.00",
            "click_ip": "58.227.38.245",
            "action_id": 1,
            "status": 0,
            "full_payment": "5000.00",
            "screen": "",
            "action_name": "product1",
            "payment_system": "0.00",
            "conversion_time": 2,
            "click_country": null,
            "user_language": "",
            "webmaster": "webmaster1",
            "action_time": "2013-12-10T16:30:52",
            "tracking": "1",
            "closing_date": "2013-12-19",
            "user_agent": "django-test-client",
            "action_ref": ""
        }
    ],
    "_meta": {
        "count": 5,
        "limit": 2,
        "offset": 0
    }
}

Description of API server response fields

Name

Description

id Admitad ID
action_country

Country of action

action_id

Rate ID

action_ip

Action IP address

action_name

Rate

action_ref

Action referrer

action_time

Time of action

click_country

Country of click

click_ip

Click IP address

click_ref

Click referrer

click_time

Click time

closing_date

Date of application

conversion_time

Conversion time

currency

Currency

full_payment

General expenses

order_id

Order ID

order_sum

Order amount

payment_system

Expenses on the system

payment_webmaster

Expenses on publishers

screen

Screen resolution

status

Status

tracking Tracking
uid

Visitor UID

user_agent

User’s browser

user_language

User language

webmaster

Publisher

website_id

Ad space

comment

Comment