List Campaigns

GET /campaigns
Copied
Arrow
                https://api.ocamba.com/api/v1/adex/campaigns

Returns a list of Campaigns

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
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.
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.
namestring
Name of the object.


Example: name=ExampleName
statusstring
Describe status of the object.


Example: status=status1
typestring
Describe type of the object.


Example: type=type1
account_idstring
Unique account identifier defined as a query parameter.


Example: account_id=12345
creator_idstring
Unique creator identifier defined as a query parameter.


Example: creator_id=12345
pricing_modelstring



Example: pricing_model=cpc
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ campaigns ]
An array of all created items.
Campaign
Name
Description
account_idstring
A unique account identifier generated by the Ocamba platform.


Example: 52794322
configured_statusstring
The configured_status reflects the current status of the campaign configured by the client, regardless of the parent object status.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived
create_timedateTime
Timezone: GMT.


Example: 2021-09-29 15:40:10
descriptionstring
Additional describtion of campaign, maximum 600 characters.


Example: Description goes here
end_timedateTime
A time when the campaign employment is over. At this point, campaign status will be automatically changed to 'paused' by backed processes. Timezone: GMT.


Example: 2021-10-29 13:07:04
exchange_idnumber
Exchange id created on the Ocamba platform. If exchange_id is set, the campaign type will be implicitly set to "external" otherwise, the campaign type will be "internal".


Example: 12341
frequency_capobject

Name
Description
impressionobject

Name
Description
expiry_timenumber
Time frame for frequency capping, expressed in hours.


Example: 10
max_countnumber
Max number of times a user sees ads for a given time frame.


Example: 2
iab_category[ string ]
An array of maximum 3 unique items, where every item must be a valid IAB category.


Example: IAB1-1,IAB1-2
idstring
A unique identifier generated by the Ocamba platform.


Example: 10001233
namestring
Name of the campaign, max 200 characters.


Example: DemoCampaign
pricing_modelstring
Assigning the wanted pricing model to campaign.


Example: cpc

Possible values: cpc | cpm | cpa
remote_idnumber
Campaign id from an external source.


Example: 42131
scorenumber (integer)
Minimum value - 0, Maximum value - 100.


Example: 78

Default: 50
start_timedateTime
A time when the campaign will be employed. Only campaigns with active status will be employed once the start time is reached. If the start time is not specified, the campaign will start immediately. Timezone: GMT.


Example: 2021-10-20 12:47:00
statusstring
The status reflects the current status of the campaign which may be overridden by its parent or by some background processes.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived | hourly-limit | daily-limit | monthly-limit | lifetime-limit
sync_statusnumber (integer)
Describes campaign sync status.


Example: 2

Possible values: 0 | 1 | 2 | 3
typestring
Describes type of the campaign.


Example: internal

Possible values: internal | external
totalinteger
A total number of items.


Example: 92

tip
1 Searchable fields are name and description.
2 Sortable fields are name, pricing_model, create_time.
info
1 The response example is representing a full view.

Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 92,
  "items": [
    {
      "id": "10001233",
      "account_id": "52794322",
      "name": "DemoCampaign",
      "status": "active",
      "configured_status": "active",
      "type": "internal",
      "pricing_model": "cpc",
      "score": 78,
      "iab_category": [
        null
      ],
      "frequency_cap": {
        "impression": {
          "expiry_time": 10,
          "max_count": 2
        }
      },
      "start_time": "2021-10-20 12:47:00",
      "end_time": "2021-10-29 13:07:04",
      "remote_id": 42131,
      "exchange_id": 12341,
      "sync_status": 2,
      "description": "Description goes here",
      "create_time": "2021-09-29 15:40:10"
    }
  ]
}