View List

GET /lists/{id}
Copied
Arrow
                https://api.ocamba.com/v2/adex/lists/{id}

Retrieves the details of a List that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
List id.


Example: 1162
query Parameters
Arrow
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

Response status codes
Arrow
200 - OK
Arrow
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
Describes a type of list.


Example: country

Possible values: category | country | domain | ip | keyword | subid | zone | region
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: 10
tip
1 If you don't know the list id, list the lists to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": [
    {
        "id": "1862",
        "company_id": "6197120",
        "account_id": "93662681",
        "name": "test",
        "type": "category",
        "zone_count": 1,
        "create_time": "2020-10-29 07:39:52",
        "update_time": "2021-12-06 12:59:13"
    }
  ]
}

{
  "total": 10,
  "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"
    }
  ]
}