List Campaign groups

GET /campaign-groups
Copied
Arrow
                https://api.ocamba.com/api/v1/adex/campaign-groups

Returns a list of Campaign groups

query Parameters
Arrow
Name
Description
campaign_idstringrequired
Unique campaign identifier defined as a path parameter.


Example: campaign_id=102
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.
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ campaign-groups ]
An array of all created items.
Campaign Group
Name
Description
campaign_countstring
Number of campaigns in group.


Example: 8
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
namestring
Max 30 chars. Name may only contain letters, numbers, dashes and underscores.


Example: My-group
totalinteger
A total number of items.


Example: 2
tip
1 If you don't know the campaign group id, list the campaign groups to find it.
2 Searchable fields are name and id.
3 Sortable fields are name and id.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": "2",
    "items": [
        {
            "id": "964",
            "name": "12 Monkeys",
            "color": "#3bafd9",
            "campaign_count": "230",
            "create_time": "2021-09-01 11:50:39"
        },
        {
            "id": "368",
            "name": "my-group",
            "color": "#3bafd9",
            "campaign_count": "18",
            "create_time": "2020-12-15 08:57:22"
        }
    ]
}

{
  "total": 2,
  "items": [
    {
      "id": "103",
      "name": "My-group",
      "color": "#00efa7",
      "campaign_count": "8",
      "create_time": "2021-09-29 15:40:10"
    }
  ]
}