View Account limit

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

Retrieves the details of a Account 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
account_idstringrequired
Unique account identifier 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 /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
viewstring
Ocamba 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[ account-limit ]
An array of all created items.
Account Limit
Name
Description
account_idstring
A unique account identifier generated by the Ocamba platform.


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


Example: 1000001
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000
itemstring
Depends on the type. If type is budget allowed values are income and expense. If type is frequency allowed values are: impressions, clicks and conversions.


Example: income

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


Example: day

Possible values: hour | day | month | lifetime
typestring
Represent the type of the account limit.


Example: budget

Possible values: budget | frequency
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
valueinteger
Value of the upper limit.


Example: 1
totalinteger
A total number of items.


Example: 1
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 1,
  "items": [
    {
      "id": "1000",
      "company_id": "1000001",
      "account_id": "1000000",
      "type": "budget",
      "item": "income",
      "period": "day",
      "value": 1,
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}