Get all advertisers

HTTP method

Endpoint

GET

/v1/advertisers

Get all advertisers in a network.

Query string parameters

Conditions

Parameters

Type

Description

Offset

offset

offset

Check page scale.

Limit

limit

limit

The number of date displays in each page. Maximum = 1000

Sort

sort

sort

Ranking according to the specified field ascending "+", or descending "-".

Filters

filters

filter

Query requirements of Specify field.

EQUAL_TO NOT_EQUAL_TO LESS_THAN LESS_THAN_OR_EQUAL_TO GREATER_THAN GREATER_THAN_OR_EQUAL_TO CONTAINS NOT_CONTAINS NULL NOT_NULL

Fields

fields

field

You can choose the field of the query (the result of the query is in line with the selected field).

id

integer

A string that uniquely identifies this advertiser.

first_name

string

The first_name of the this Advertiser.

last_name

string

The last_name of the this Advertiser.

email

string

The email of the this Advertiser.

company

string

The company of the this Advertiser.

country

string

The country of the Advertiser's physical address.

status

string

Advertiser status.

instant_message_account

string

Instant messaging account.

instant_message_type

integer

types of instant messaging.

manager_id

integer

Account Manager ID.

phone

string

The phone number of the Advertiser.

website

string

security_mode

integer

selection to activate security code. 0:close ; 1:open

security_code

string

conversion security code

create_time

integer

Create time

Response body parameters

Field

Type

Description

id

integer

A string that uniquely identifies this advertiser.

first_name

string

The first_name of the this Advertiser.

last_name

string

The last_name of the this Advertiser.

email

string

The email of the this Advertiser.

company

string

The company of the this Advertiser.

country

string

The country of the Advertiser's physical address.

status

string

Advertiser status.

instant_message_account

string

Instant messaging account.

instant_message_type

integer

types of instant messaging.

manager_id

integer

Account Manager ID.

phone

string

The phone number of the Advertiser.

website

string

security_mode

integer

selection to activate security code. 0:close ; 1:open

security_code

string

conversion security code

create_time

integer

Create time

totalPages

integer

The list of data pages (associated with your limit).

totalRows

integer

Total number of available data.

offset

integer

The number of records from a collection to skip. Iterating over large collections with this parameter can be slow.

limit

integer

The number of data displayed on one page

Example request

Request GET https://{networkname}.api.offerslook.com/v1/advertisers?limit=4&filters[status][EQUAL_TO]=active&sort=-id,+name&fields=id,name,status,phone

Request GET http://{networkname}.api.offerslook.com/v1/advertisers?limit=4&filters[status][EQUAL_TO]=active&sort=-id,+name&fields=id,name,status,phone

Example response

    {
      "code": 0,
      "message": "Success",
      "data": {
        "rowset": [
          {
            "id": 4853,
            "status": "active",
            "phone": ""
          },
          {
            "id": 4849,
            "status": "active",
            "phone": ""
          },
          {
            "id": 4822,
            "status": "active",
            "phone": "21155571"
          },
          {
            "id": 696,
            "status": "active",
            "phone": "11122233333"
          }
        ],
        "totalPages": 3,
        "totalRows": 9,
        "offset": 1,
        "limit": 4
      }
    }

Last updated