View Campaign limit

GET /campaigns/{id}/limits/{limit_id}
Copied
Arrow
                https://api.ocamba.com/v2/adex/campaigns/{id}/limits/{limit_id}

Retrieves the details of a Campaign limit 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
limit_idstringrequired
Unique limit identifier.


Example: limit_id=7323
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ campaign-limits ]
An array of all created items.
Campaign Limit
Name
Description
campaign_idstring
An unique identifier of the campaign the limit is attached to.


Example: 1012346
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 6197120
create_timedateTime
Timezone: GMT.


Example: 2021-10-29 15:40:10
idstring
An unique identifier generated by the Ocamba platform.


Example: 1612
itemstring
Represents the subtype of the campaign limit. Possible values depend on type of limit.


Example: impressions

Possible values: income | expense | impressions | clicks | conversions
periodstring
Describes the period of the limit.


Example: hour

Possible values: hour | day | month | lifetime
typestring
Describes a type of the campaign limit.


Example: frequency

Possible values: frequency | budget
update_timedateTime
Timezone: GMT.


Example: 2021-10-29 15:40:10
valuenumber
A number between 1 and 4000000000.


Example: 1000
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the campaign limit id, list the campaign limits to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": 
  {
    "id": "7005",
    "company_id": "6197120",
    "campaign_id": "1012346",
    "type": "frequency",
    "item": "impressions",
    "period": "day",
    "value": 123412412,
    "create_time": "2023-08-09 09:52:00",
    "update_time": "2023-08-09 09:56:28"
  }
}

{
  "total": 1,
  "items": [
    {
      "id": "1612",
      "company_id": "6197120",
      "campaign_id": "1012346",
      "type": "frequency",
      "item": "impressions",
      "period": "hour",
      "value": 1000,
      "create_time": "2021-10-29 15:40:10",
      "update_time": "2021-10-29 15:40:10"
    }
  ]
}