View Campaign limit

GET /campaign-limits/{id}
Copied
Arrow
                https://api.ocamba.com/api/v1/adex/campaign-limits/{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
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-limits ]
An array of all created items.
Campaign Limit
Name
Description
budget_typestring
Depends on the field type. Represents the subtype of campaign limit.


Example: income

Possible values: income | expense
idstring
A unique identifier generated by the Ocamba platform.


Example: 994
limit_valuenumber (integer)
Minimum value is 1.


Example: 3
methodstring
Depends on the field type. Represents the subtype of campaign limit.


Example: impressions

Possible values: impressions | clicks | conversions
periodstring
Describe the period of the limit.


Example: day

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


Example: budget

Possible values: budget | frequency
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",
  "limits": [
    {
      "id":"994",
      "type":"budget",
      "period":"day",
      "limit_value":"10",
      "budget_type":"income"
    }
  ]
}

{
  "total": 1,
  "items": [
    {
      "id": "994",
      "type": "budget",
      "budget_type": "income",
      "period": "day",
      "method": "impressions",
      "limit_value": 3
    }
  ]
}