View Campaign

GET /campaigns/{id}
Copied
Arrow
                https://api.ocamba.com/v2/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
stat_datestring
Date associated with the stats data. Retention policy is 100 days.


Example: stat_date=rf:2024-04-04,2024-04-23

Response status codes
Arrow
200 - OK
Arrow
Name
Description
accountobject

Name
Description
idstring
Id of the account, same as account_id.


Example: 10073337
imagestring
A link to the account image.


Example: https://dev-storage.ocamba.com/6197120/adex/accounts/90130201/images/%D9%8A%D9%8A%D9%8A%D9%8A%D9%8A.png
namestring
Name of the accound holder.


Example: John Smith
statusstring
Status of the account.


Example: active
account_idstring
A unique account identifier generated by the Ocamba platform.


Example: 52794322
bid_modifiers[ string ]
Array of bid modifier ids. Each element must be a unique bid modifier id supported by Ocamba.


Example: 1213,2232,4432
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 7196310
cpc_bid_strategy_idstring
Valid cpc bid strategy id supported by Ocamba.


Example: 1231
cpm_bid_strategy_idstring
Valid cpm bid strategy id supported by Ocamba.


Example: 1332
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
creative_distributionnumber (int)
Describes the status of creative distribution on a campaign. Settable only through the distribute endpoints.


Example: 1

Possible values: 0 | 1
creative_typesstring
Describes the types of creatives on a campaign.


Example: dynamic-native,web-push-object
creatorobject

Name
Description
idstring
Id of the creator, same as creator_id.


Example: 1000225
imagestring
Image of the creator.


Example: https://dev-storage.ocamba.com/6197120/adex/accounts/90130201/images/%D9%8A%D9%8A%D9%8A%D9%8A%D9%8A.png
namestring
Name of the creator.


Example: John Smith
creator_idstring
A unique creator identifier generated by the Ocamba platform.


Example: 1000225
descriptionstring
Additional description of campaign, maximum 2000 characters.


Example: Description goes here
effective_statusstring
The status of the campaign set by background processes. The same as status if campaign is not in limit.


Example: monthly-limit

Possible values: active | verification | rejected | paused | inactive | archived | hourly-limit | daily-limit | monthly-limit | lifetime-limit
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
external_demandobject

Name
Description
idstring
Id of the external demand, same as external_demand_id.


Example: 7552
namestring
Name of the external demand.


Example: Demo External Demand
partner_idstring
Id of the external demand partner.


Example: 280
statusstring
Status of the external demand.


Example: active
external_demand_idstring
External demand id created on the Ocamba platform. If external_demand_id is set, the campaign type will be implicitly set to "external" otherwise, the campaign type will be "internal". Pricing model of external demand must match the pricing model of the campaign.


Example: 12341
frequency_capobject

Name
Description
clickobject

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
conversionobject

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
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
has_creativesnumber (int)
Shows if campaign has any creatives.


Example: 1

Possible values: 0 | 1
iab_categories[ string ]
Array of unique iab category ids, supported by Ocamba. Maximum number of elements is 3.


Example: IAB1,IAB2
idstring
A unique identifier generated by the Ocamba platform.


Example: 10001233
max_bidfloat
Maximum bid on a campaign.


Example: 12.24
metadataobject

Name
Description
keystring
Key for the metadata.
Each key must be unique within the metadata object. Maximum 100 characters.


Example: key1
valuestring
Value for the metadata. Maximum 500 characters.


Example: value1
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_idstring
Campaign id from an external source. Can not have two campaigns with the same remote id.


Example: 1241412
scorenumber (integer)
Campaign score. Minimum value - 0, Maximum value - 100.


Example: 78

Default: 50
source_campaign_idstring
Original campaign id. Exists only for copied campaigns.


Example: 1231412
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
statsobject

Name
Description
clicknumber
Number of clicks.


Example: 451
conversionnumber
Number of conversions.


Example: 661
ctrfloat
The rate of clicks to impressions.


Example: 10.84
impressionnumber
Number of impressions.


Example: 111
incomefloat
The total income.


Example: 125.65
spam_clicknumber
Number of spam clicks.


Example: 113
statusstring
The status of the campaign set by the user. May differ from the actual status of the campaign.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived
sync_statusstring
Describes the sync status of a campaign.


Example: 2
targetingcampaign-targeting
Targeting object.
Campaign Targeting
Name
Description
browsersobject

Name
Description
items[ object ]
Array of browser items, maximum length limited by subscription plan.
categoriesobject

Name
Description
itemsarray
Array of strings containing category ids.
opstring
String describing operation. Possible values are eq and neq
connectionsobject

Name
Description
items[ string ]
Array of valid connection types supported by Ocamba.
opstring



Example: nin

Possible values: in | nin
containersobject

Name
Description
items[ string ]
Array of strings containing containers ids. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
countriesobject

Name
Description
items[ string ]
Array of country codes supported by ocamba (ISO 3166-1, 2 letter country codes), maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type country, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
device_manufacturersobject

Name
Description
items[ string ]
Array of device manufacturer ids, maximum length limited by subscription plan.
opstring



Example: in

Possible values: in | nin
device_trackingnumber (integer)
Describes the status of device tracking.


Example: 1

Possible values: 0 | 1
device_typesobject

Name
Description
items[ string ]
Array of device types, maximum length limited by subscription plan.
opstring



Example: in

Possible values: in | nin
has_user_datanumber (integer)
Describes the availability of user data


Example: 1

Possible values: 0 | 1
ipobject

Name
Description
items[ string ]
Array of ips, each element must be a valid ipv4/cidr, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type ip, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
keywordsobject

Name
Description
itemsarray
Array of unique strings containing keywords. One item can be a string with minimum length of 3 and maximum of 150, containing max 20 groups separated by \|. Each group can be made up of these characters: a-zA-Z0-9_%!


Example: keyword01!\|keyword02_%
languagesobject

Name
Description
items[ string ]
Array of unique strings. Each element must be a valid 2-letter language code supported by Ocamba platform, maximum number of items limited by subscription plan.
opstring



Example: nin

Possible values: in | nin
osobject

Name
Description
items[ object ]
Array of os items, maximum length limited by subscription plan.
pagesobject

Name
Description
items[ string ]
Array of domains, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type domain, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
regionsobject

Name
Description
items[ string ]
Array of region ids generated by the Ocamba platform, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type region, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
subidsobject

Name
Description
items[ string ]
Array of subids, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type subid, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
tagsobject

Name
Description
items[ string ]
Array of tag ids, maximum length limited by subscription plan. This field is deprecated and will be removed in future. Please use container as a replacement.
opstring



Example: in

Possible values: in | nin
timeobject

Name
Description
items[ string ]
Array of valid cron expressions, maximum length limited by subscription plan.
opstring



Example: in

Possible values: in | nin
user_ageobject

Name
Description
fromnumber (integer)



Example: 20
time_unitstring



Example: hour

Possible values: hour | day
tonumber (integer)



Example: 30
typestring
Describes type of the campaign. Type is set on creation of a campaign.


Example: internal

Possible values: internal | external
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26

tip
1 If you don't know the campaign id, list the campaigns to find it.
info
1 The response example is representing a full view.

Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": [
    {
      "name": "example_campaign_name",
      "description": "This is my first campaign.",
      "status": "active",
      "pricing_model": "cpc",
      "account_id": "10073337",
      "targeting": {
        "countries": {
          "items": [
            "RS"
          ],
          "lists": [
            "1838"
          ],
          "op": "in"
        },
        "regions": {
          "items": [
            "2661876"
          ],
          "lists": [
            "2934"
          ],
          "op": "in"
        },
        "subids": {
          "items": [
            "fut_t10_18-24-MULTI_GG"
          ],
          "lists": [
            "1835"
          ],
          "op": "in"
        },
        "ip": {
          "items": [
            "123.523.123.4"
          ],
          "lists": [
            "2691"
          ],
          "op": "in"
        },
        "pages": {
          "items": [
            "ocamba.com"
          ],
          "lists": [
            "2725"
          ],
          "op": "in"
        },
        "tags": {
          "items": [
            "1303"
          ],
          "op": "in"
        },
        "device_types": {
          "items": [
            "console"
          ],
          "op": "in"
        },
        "device_manufacturers": {
          "items": [
            "13"
          ],
          "op": "in"
        },
        "os": {
          "items": [
            {
              "id": "12",
              "op": "in",
              "versions": [
                "10.0"
              ]
            }
          ]
        },
        "browsers": {
          "items": [
            {
              "id": "10",
              "op": "in",
              "versions": [
                "10.0"
              ]
            }
          ]
        },
        "connections": {
          "items": [
            "1"
          ],
          "op": "nin"
        },
        "time": {
          "items": [
            "[0,15,30,45 12,13,14 * 6 1]"
          ],
          "op": "in"
        },
        "device_tracking": 1,
        "has_user_data": 1
      },
      "metadata": {
        "key1": "value1"
      }       
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

{
  "id": "10001233",
  "company_id": "7196310",
  "account_id": "52794322",
  "account": {
    "id": "10073337",
    "name": "John Smith",
    "status": "active",
    "image": "https://dev-storage.ocamba.com/6197120/adex/accounts/90130201/images/%D9%8A%D9%8A%D9%8A%D9%8A%D9%8A.png"
  },
  "creator_id": "1000225",
  "creator": {
    "id": "1000225",
    "name": "John Smith",
    "image": "https://dev-storage.ocamba.com/6197120/adex/accounts/90130201/images/%D9%8A%D9%8A%D9%8A%D9%8A%D9%8A.png"
  },
  "external_demand_id": "12341",
  "external_demand": {
    "id": "7552",
    "partner_id": "280",
    "status": "active",
    "name": "Demo External Demand"
  },
  "source_campaign_id": "1231412",
  "remote_id": "1241412",
  "name": "DemoCampaign",
  "description": "Description goes here",
  "status": "active",
  "effective_status": "monthly-limit",
  "type": "internal",
  "pricing_model": "cpc",
  "score": 78,
  "bid_modifiers": [
    null
  ],
  "cpc_bid_strategy_id": "1231",
  "cpm_bid_strategy_id": "1332",
  "max_bid": 12.24,
  "creative_types": "dynamic-native,web-push-object",
  "creative_distribution": 1,
  "has_creatives": 1,
  "iab_categories": [
    null
  ],
  "frequency_cap": {
    "impression": {
      "expiry_time": 10,
      "max_count": 2
    },
    "click": {
      "expiry_time": 10,
      "max_count": 2
    },
    "conversion": {
      "expiry_time": 10,
      "max_count": 2
    }
  },
  "start_time": "2021-10-20 12:47:00",
  "end_time": "2021-10-29 13:07:04",
  "stats": {
    "impression": 111,
    "click": 451,
    "spam_click": 113,
    "conversion": 661,
    "income": 125.65,
    "ctr": 10.84
  },
  "targeting": {
    "countries": {
      "items": [
        "RS"
      ],
      "lists": [
        "1838"
      ],
      "op": "in"
    },
    "regions": {
      "items": [
        "2661876"
      ],
      "lists": [
        "2934"
      ],
      "op": "in"
    },
    "subids": {
      "items": [
        "fut_t10_18-24-MULTI_GG"
      ],
      "lists": [
        "1835"
      ],
      "op": "in"
    },
    "ip": {
      "items": [
        "123.523.123.4"
      ],
      "lists": [
        "2691"
      ],
      "op": "in"
    },
    "pages": {
      "items": [
        "ocamba.com"
      ],
      "lists": [
        "2725"
      ],
      "op": "in"
    },
    "tags": {
      "items": [
        "1303"
      ],
      "op": "in"
    },
    "containers": {
      "items": [
        "1020"
      ],
      "op": "in"
    },
    "device_types": {
      "items": [
        "console"
      ],
      "op": "in"
    },
    "device_manufacturers": {
      "items": [
        "13"
      ],
      "op": "in"
    },
    "os": {
      "items": [
        {
          "id": "12",
          "op": "in",
          "versions": [
            "10.0"
          ]
        }
      ]
    },
    "browsers": {
      "items": [
        {
          "id": "10",
          "op": "in",
          "versions": [
            "10.0"
          ]
        }
      ]
    },
    "connections": {
      "items": [
        "1"
      ],
      "op": "nin"
    },
    "time": {
      "items": [
        "[0,15,30,45 12,13,14 * 6 1]"
      ],
      "op": "in"
    },
    "languages": {
      "items": [
        "sr"
      ],
      "op": "nin"
    },
    "keywords": {
      "items": "keyword01!\\|keyword02_%"
    },
    "categories": {},
    "user_age": {
      "from": 20,
      "to": 30,
      "time_unit": "hour"
    },
    "device_tracking": 1,
    "has_user_data": 1
  },
  "metadata": {
    "key": "key1",
    "value": "value1"
  },
  "sync_status": "2",
  "create_time": "2021-10-29 12:47:00",
  "update_time": "2021-10-30 14:27:26"
}