List Unit sizes

GET /unit-sizes
Copied
Arrow
                https://api.ocamba.com/v2/adex/unit-sizes

Returns a list of Unit sizes

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
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
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
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.
idstring
Unit size id. Created by combining width and height fields (WxH).


Example: id=120x120
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ unit-size ]
An array of all created items.
Unit Size
Name
Description
company_idstring
Identifier of a company related to this unit size.


Example: 4554545
create_timedateTime
Timezone: GMT.


Example: 2021-09-29 15:40:10
groupstring
Unit size group. By default, it has a value of 'Custom'. Unit size group iz not updatable.


Example: Custom
heightinteger
Unit size height.


Example: 120
idstring
Unit size identificator. Created by combining width and height fields (WxH).


Example: 120x120
namestring
Unit size name.


Example: medium ad size
typestring
Unit size type. By default, it has a value of 'custom'. Unit size type is not updatable.


Example: custom
update_timedateTime
Timezone: GMT.


Example: 2021-09-29 15:40:10
visibilityinteger
Unit size visibility. Can be 0 or 1. On unit size creation, visibility is always set to 1. Unit size visibility is not updatable.


Example: 1
widthinteger
Unit size width.


Example: 120
totalinteger
A total number of items.


Example: 1
tip
1 Searchable fields are id and name.
2 Sortable fields are: name, type, group, width, height, create_time and update_time.
3 Filterable fields are: id, name, type, group, visibility, width, height, create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 1,
  "items": [
    {
      "id": "120x120",
      "company_id": "4554545",
      "name": "medium ad size",
      "type": "custom",
      "group": "Custom",
      "visibility": 1,
      "width": 120,
      "height": 120,
      "create_time": "2021-09-29 15:40:10",
      "update_time": "2021-09-29 15:40:10"
    }
  ]
}