View Campaign group

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

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

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
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

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: 1
tip
1 If you don't know the campaign group id, list the campaign groups to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": [
    {
      "id": "102",
      "name": "my-group",
      "color": "#00efa7",
      "campaign_count": "8",
      "create_time": "2019-11-25 09:27:47"
    }
  ]
}

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