List Campaign limits

GET /campaign-limits
Copied
Arrow
                https://api.ocamba.com/api/v1/adex/campaign-limits

Returns a list of Campaign limits

query Parameters
Arrow
Name
Description
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
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.
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.
campaign_idstring
Unique campaign identifier.


Example: campaign_id=994
typestring
Describes a type of campaign limits.


Example: type=budget
periodstring
Describe the period of the limit.


Example: period=day
limit_valuestring
Minimum value.


Example: limit_value=4
budget_typestring
Depends on the field type. Represents the subtype of campaign limit.


Example: budget_type=income
methodstring
Depends on the field type. Represents the subtype of campaign limit.


Example: method=clicks
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: 2
tip
1 If you don't know the campaign id, list the campaigns to find it.
2 Searchable field is id.
3 Sortable fields are: id, type, period, method and budget_type.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": "2",
  "items": [
    {
      "id":"994",
      "type":"budget",
      "period":"day",
      "limit_value":"10",
      "budget_type":"income"
    },
    {
      "campaign_id":"1008865",
      "type":"frequency",
      "period":"day",
      "limit_value":"10",
      "method":"clicks"
    }
  ]
}

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