The list of publisher’s ad spaces

Parameters

HTTP method

Access rights

URL

Parameters

Note

GET websites https://api.admitad.com/websites/
  • offset**
  • limit**
  • status***
  • campaign_status****

Returns the list of ad spaces.*

GET websites https://api.admitad.com/websites/{id}/  

Returns the ad space, where id is ad space identifier.*

  • * Returns the result in the JSON format.

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

  • *** Filter by ad space status. Possible values:
    • new
    • pending
    • active
    • suspended
    • declined
  • **** Filter by the status of ad space affiliate programs Possible values:
    • pending
    • active
    • declined
    • disabled

Example of use

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

curl -L -H 'Authorization: Bearer access-token' -X GET https://api.admitad.com/websites/?limit=1&offset=8

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

{
    "results": [
        {
            "status": "active",
            "kind": "social_app",
            "is_old": false,
            "name": "vkontakte.ru",
            "language": "ru",
            "creation_date": "2012-02-16 16:41:37",
            "verification_code": "d2b3d05c3d",
            "site_url": "http://vkontakte.ru/app123",
            "regions": [
                {
                    "region": "RU",
                    "id": 8
                }
            ],
            "adservice": {
                "id": 5,
                "name": "VKontakte"
            },
            "id": 40,
            "categories": [
                {
                    "name": "Shop",
                    "parent": null,
                    "id": 1
                },
                {
                    "name": "Online Games",
                    "parent": null,
                    "id": 2
                },
                {
                    "name": "Other",
                    "parent": null,
                    "id": 5
                },
                {
                    "name": "Test",
                    "parent": null,
                    "id": 16
                }
            ],
            "description": "description"
        }
    ],
    "_meta": {
        "count": 11,
        "limit": 1,
        "offset": 8
    }
}

Description of API server response fields

Name

Description

id

Ad space ID

name

Name of ad space

description

Ad space description

status

Ad space status

creation_date

Ad space creation date

site_url

Ad space website

verification_code

Verification code

kind Types of ad spaces
language System languages
regions Ad space regions
adservice List of advertising services
categories Categories of affiliate programs