View Campaign

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

Retrieves the details of a Campaign 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
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

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
A feature that limits the number of times that your ads will appear to the same user for a given time frame.
Name
Description
impressionobject
Impression desctiption placeholder.
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: 1
tip
1 If you don't know the campaign id, list the campaigns to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
	"total": 1,
	"items": [
    {
	  	"id": "1009154",
	  	"remote_id": null,
	  	"name": "My first campaign",
	  	"status": "active",
	  	"type": "internal",
	  	"pricing_model": "cpm",
	  	"score": "60",
	  	"iab_category": null,
	  	"sync_status": "1",
	  	"description": null,
	  	"start_time": "2020-10-14 10:00:00",
	  	"end_time": null,
	  	"create_time": "2020-08-14 07:10:09"
	  }
  ]
}

{
  "total": 1,
  "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"
    }
  ]
}