Collection of Lists

Copied

                https://api.ocamba.com/v2/adex/lists

Returns a collection of Lists

query Parameters

Name

Description

fieldsstring

The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /VERSION/adex/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.

Example: fields=field1,field2,field3

viewstring

Adex API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.

Example: view=full/default

pagestring

The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.

Example: page=1,10

sortstring

Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/adex/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/adex/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/adex/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.

Example: sort=-field1,field2

q_fieldsstring

Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring

Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/adex/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.

idstring

List id.

Example: 1862

account_idstring

Unique account identifier defined as a query parameter.

Example: account_id=12345

typestring

Describe type of the object.

Example: type=type1

namestring

Name of the object.

Example: name=ExampleName

update_timestring

Timezone: GMT.

Example: update_time="2021-09-14"

create_timestring

Timezone: GMT.

Example: create_time="2021-09-14"

campaign_countinteger

Represent the number of how many campaigns are using the list.

Example: campaign_count=12

zone_countinteger

Represent the number of how many zones are using the list.

Example: zone_count=10

Response status codes

200 - OK

Name

Description

items[ list ]

An array of all created items.

List

Name

Description

account_idstring

A unique account identifier generated by the Ocamba platform.

Example: 1234123

campaign_countnumber (integer)

Represent the number of how many campaigns are using the list.

Example: 13

company_idstring

A unique company identifier generated by the Ocamba platform.

Example: 1234123

create_timestring

Timezone: GMT.

Example: 2021-10-29 12:47:00

idstring

A unique identifier generated by the Ocamba platform.

Example: 2345

itemslist-items-by-type

Items must be a string, value depends on list type. For examples check list-items-by-type or request example.

List Items

Name

Description

categorystring

Category list items must be a string of valid category IDs supported by Ocamba, separated by a comma.

Example: IAB1,IAB11,IAB3

countrystring

Country list items must be valid a string of two letter country codes supported by Ocamba, separated by a comma.

Example: RS,DE,JP,GB

domainstring

Domain list items must be a string of fully qualified domain names separated by a comma. Domain length must be between 3 and 100 characters.

Example: example.domain.com,another.example.com

ipstring

Ip list items must be a string of ip addresses in an ipv4, ipv6 or cidr format for both v4 and v6, separated by a comma.

Example: 192.168.0.1,1.1.1.1,192.168.0.15/28,1.2.3.4,2001:0db8:85a3:33a1:ff12:8a2e:0370:7334/23,2301:0db2:84a3:34a1:ff42:8a1e:0270:7324

keywordstring

String containing keywords separated by a comma. Keyword must be a string with minimum length of 3 and maximum of 150, containing max 20 groups separated by \|. Each group can be made up of these characters: a-zA-Z0-9_%!

Example: keyword01!\|keyword02_%,example_keyword|another_example

regionstring

Region list item must be a string of region IDs supported by Ocamba, separated by a comma.

Example: 292969,3183560,7581800

subidstring

String containing subids separated by a comma. Subid can be any string with length between 1 and 200 characters.

Example: subid_1,subid2,sub_id_3

zonestring

Zone list items must be a string of valid zone IDs supported by Ocamba, separated by a comma.

Example: 1314550,1445589,1332565

namestring

Represents name of the list.

Example: demo_list

typestring

update_timestring

Timezone: GMT.

Example: 2021-10-30 14:27:26

zone_countnumber (integer)

Represent the number of how many zones are using the list.

Example: 10

totalinteger

A total number of items.

Example: 3

tip

1 Searchable fields are name and items.

2 Sortable fields are: name, type, campaign_count, zone_count, create_time and update_time.

3 Filterable fields are: id, name, type, campaign_count, zone_count, create_time and update_time.

Response examples

Copied

200

{
  "total": 3,
  "items": [
    {
      "id": "1862",
      "company_id": "1234123",
      "account_id": "1234123",
      "name": "test!",
      "type": "category",
      "zone_count": 1,
      "create_time": "2020-10-29 07:39:52",
      "update_time": "2021-10-01 07:51:00"
    },
    {
      "id": "2059",
      "company_id": "1234123",
      "account_id": "1234123",
      "name": "test1!",
      "type": "country",
      "campaign_count": 1,
      "zone_count": 1,
      "create_time": "2020-12-09 10:25:15",
      "update_time": "2021-09-30 12:11:01"
    },
    {
      "id": "2478",
      "company_id": "1234123",
      "account_id": "1234123",
      "name": "test123",
      "type": "country",
      "zone_count": 1,
      "create_time": "2021-06-24 10:04:38",
      "update_time": "2021-09-16 13:08:14"
    }
  ]
}

{
  "total": 3,
  "items": [
    {
      "id": "2345",
      "company_id": "1234123",
      "account_id": "1234123",
      "name": "demo_list",
      "type": "country",
      "items": {
        "country": "RS,DE,JP,GB",
        "category": "IAB1,IAB11,IAB3",
        "domain": "example.domain.com,another.example.com",
        "ip": "192.168.0.1,1.1.1.1,192.168.0.15/28,1.2.3.4,2001:0db8:85a3:33a1:ff12:8a2e:0370:7334/23,2301:0db2:84a3:34a1:ff42:8a1e:0270:7324",
        "keyword": "keyword01!\\|keyword02_%,example_keyword|another_example",
        "subid": "subid_1,subid2,sub_id_3",
        "zone": "1314550,1445589,1332565",
        "region": "292969,3183560,7581800"
      },
      "campaign_count": 13,
      "zone_count": 10,
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

Collection of Lists

GET /listsCopied https://api.ocamba.com/v2/adex/lists

GET /lists
Copied
`https://api.ocamba.com/v2/adex/lists`