List of broker applications

Parameters

HTTP method

Access rights

URL

Parameters

Note

GET broker_application https://api.admitad.com/website/{w_id}/broker/applications/ Request parameters list.

Returns the list of created applications, where w_id is the ad space ID.*

  • * Returns the result in the JSON format.

Request parameters list.

Name

Type

Requirements

offset integer limit, offset parameters
limit integer limit, offset parameters
order_by string
  • date_created

‘-‘ sign before the value means the reverse order. E.g. order_by=-date_created

id integer  
campaign integer List of affiliate programs
status string
  • processing
  • approved
  • declined
  • waiting
  • error
date_start date %d.%m.%Y
date_end date %d.%m.%Y
order_id string  
occupation string  
inn string  
product_type string  
subid string  
subid1 string  
subid2 string  
subid3 string  
subid4 string  

Example of use

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

curl -L -H 'Authorization: Bearer access_token' -X GET 'https://api.admitad.com/website/{w_id}/broker/applications/?offset=0&limit=1'

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

{
    "results": [
        {
            "id": 1,
            "subid": "",
            "subid1": "",
            "subid3": "",
            "subid2": "",
            "subid4": "",
            "responses": [
                {
                    "campaign_id": 1
                    "status": "processing",
                    "order_id": null,
                    "server_response": {
                        "message": "objects_list_returned_ok",
                        "code": 200,
                        "data": false
                    }
                }
            ]
        }
    ],
    "_meta": {
        "count": 1,
        "limit": 1,
        "offset": 0
    }
}

Description of API server response fields

Name

Description

id

Application ID

responses

Information about sending an application in the program

errors

Error when creating an application

subid

Additional parameter

subid1

Additional parameter 1

subid2

Additional parameter 2

subid3

Additional parameter 3

subid4

Additional parameter 4

Description of the fields in the information about sending an application in the program

Name

Description

campaign_id

Program ID

status
Application status
  • processing (waiting to be sent to the program)

  • approved (approved by the program)

  • declined (declined by the program)

  • waiting (being processed by the program)

  • error (errors on the side of the program)

order_id

Order ID in the system

server_response

Advertiser server response