List Categories

GET /categories
Copied
Arrow
                https://api.ocamba.com/v2/adex/categories

Returns a list of Categories

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
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
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
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
Category id.


Example: id=IAB1-1
parent_idstring
Category parent id.


Example: sub_id=IAB1
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ category ]
An array of all created items.
Category
Name
Description
idstring
Category id.


Example: IAB1-1
namestring
Name of the category.


Example: Arts & Entertainment
parent_idstring
Category parent id.


Example: IAB1
totalinteger
A total number of items.


Example: 10
tip
1 Searchable field is name.
2 Sortable fields are id and name.
3 Filterable fields are id and name.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 10,
  "items": [
    {
      "id": "IAB1",
      "name": "Arts & Entertainment"
    },
    {
      "id": "IAB1-1",
      "name": "Books & Literature",
      "sub_id": "IAB1"
    },
    {
      "id": "IAB1-2",
      "name": "Celebrity Fan/Gossip",
      "sub_id": "IAB1"
    },
    {
      "id": "IAB1-3",
      "name": "Fine Art",
      "sub_id": "IAB1"
    },
    {
      "id": "IAB1-4",
      "name": "Humor",
      "sub_id": "IAB1"
    },
    {
      "id": "IAB1-5",
      "name": "Movies",
      "sub_id": "IAB1"
    },
    {
      "id": "IAB1-6",
      "name": "Music",
      "sub_id": "IAB1"
    },
    {
      "id": "IAB1-7",
      "name": "Television",
      "sub_id": "IAB1"
    },
    {
      "id": "IAB10",
      "name": "Home & Garden"
    },
    {
      "id": "IAB10-1",
      "name": "Appliances",
      "sub_id": "IAB10"
    }
  ]
}

{
  "total": 10,
  "items": [
    {
      "id": "IAB1-1",
      "name": "Arts & Entertainment",
      "parent_id": "IAB1"
    }
  ]
}