List Campaign groups

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

Returns a list of Campaign groups

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
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
Unique campaign group id.


Example: 1411
campaign_idnumber (integer)
Campaign unique identifier used to get campaign groups containing campaign with given identifier.


Example: 12345
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ campaign-group ]
An array of all created items.
Campaign Group
Name
Description
colorstring
Valid hex color code.


Example: #00efa7
create_timedateTime
Timezone: GMT.


Example: 2021-09-29 15:40:10
idstring
A unique identifier generated by the Ocamba platform.


Example: 103
itemsarray
List of campaigns to be included in group. This field is only used for POST request.


Example: \"1234\",\"5678\"
namestring
Max 30 chars. Name may only contain letters, numbers, dashes and underscores.


Example: My-group
sizenumber (integer)
Number of campaigns in group. This field is automatically set to number of campaigns in group.


Example: 3
update_timedateTime
Timezone: GMT.


Example: 2021-09-29 15:40:10
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the campaign group id, list the campaign groups to find it.
2 Searchable field is name.
3 Sortable fields are name, size, create_time and update_time.
4 Filterable fields are: id, name, size, create_time and update_time.
5 You can get all campaign groups containing given campaign by putting campaign_id in query parameters.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": [
    {
      "id": "103",
      "company_id": "6197120",
      "name": "My-group",
      "color": "#00efa7",
      "size": 3,
      "create_time": "2021-09-29 15:40:10",
      "update_time": "2021-09-29 15:40:10"
    }
  ]
}

{
  "total": 1,
  "items": [
    {
      "id": "103",
      "name": "My-group",
      "color": "#00efa7",
      "size": 3,
      "items": "\\\"1234\\\",\\\"5678\\\"",
      "create_time": "2021-09-29 15:40:10",
      "update_time": "2021-09-29 15:40:10"
    }
  ]
}