List Account limits

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

Returns a list of Account limits

path Parameters
Arrow
Name
Description
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
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,filed2
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 /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members 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 /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.
idinteger
Unique identifier for the object defined as a query parameter.


Example: id=12346
typestring
Describe type of the object.


Example: type=type1
create_timestring
Timezone: GMT.


Example: create_time=2021-09-14
update_timestring
Timezone: GMT.


Example: update_time=2021-09-14
itemstring



Example: expense
periodstring
Describe the period of the limit.


Example: day
valueinteger
Value of the upper limit.


Example: 95

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: 3
tip
1 Sortable fields are: account_id, period, value, create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 3,
  "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"
    }
  ]
}