List Conversions

GET /conversions
Copied
Arrow
                https://api.ocamba.com/v2/adex/conversions

Returns a list of Conversions

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
idstring
Unique identifier for the object defined as a query parameter.


Example: id=12345
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.
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.
statusstring
Describe status of the object.


Example: status=status1
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
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ conversions ]
An array of all created items.
Conversions
Name
Description
account_idstring
Account ID


Example: 6197120
company_idstring
Company ID


Example: 6197120
create_timedateTime
Timezone: GMT.


Example: 2021-10-29 15:40:10
descriptionstring
Conversion Description


Example: The description of a Conversion has the max of 2000 characters
duplication_policynumber
Can be 0 or 1, if not passed, it will be set as 0


Example: pixel
event_counternumber
The count of the events bound to this Conversion


Example: 0
idstring
Conversions Unique Identifier


Example: 13472
methodstring
One of Conversion methods (s2s or pixel)


Example: 0

Possible values: s2s | pixel
namestring
Conversion Name


Example: Example Name
statusstring
Conversion Status can be active or inactive


Example: active

Possible values: active | inactive
update_timedateTime
Timezone: GMT.


Example: 2021-10-29 15:40:10
totalinteger
A total number of items.


Example: 31
tip
1 Searchable fields are name and description.
2 Sortable fields are name, status, duplication_policy, method, event_counter and create_time.
3 Filterable fields are id, name, status, duplication_policy, method, event_counter, create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": "31",
    "items": [
        {
            "id": "13421",
            "name": "test",
            "company_id":"6197120",
            "account_id": "6197120",
            "status": "active",
            "method": "pixel",
            "duplication_policy":1,
            "event_counter": "2",
            "create_time": "2023-07-31 06:12:31",
            "update_time": "2023-07-31 11:13:29"
        },
        {
            "id": "13422",
            "name": "demo",
            "company_id":"6197120",
            "account_id": "6197120",
            "status": "active",
            "method": "pixel",
            "duplication_policy":0,
            "event_counter": "0",
            "create_time": "2023-07-28 12:40:31",
            "update_time": "2023-07-31 10:40:47"
        },
        {
            "id": "13451",
            "name": "123",
            "company_id":"6197120",
            "account_id": "6197120",
            "status": "active",
            "method": "pixel",
            "duplication_policy":0,
            "event_counter": "0",
            "create_time": "2023-07-28 12:29:35",
            "update_time": "2023-07-28 12:36:10"
        }
    ]
}

{
  "total": 31,
  "items": [
    {
      "id": "13472",
      "company_id": "6197120",
      "account_id": "6197120",
      "name": "Example Name",
      "description": "The description of a Conversion has the max of 2000 characters",
      "status": "active",
      "method": "0",
      "duplication_policy": null,
      "event_counter": 0,
      "create_time": "2021-10-29 15:40:10",
      "update_time": "2021-10-29 15:40:10"
    }
  ]
}