List Conversion events

GET /conversion-events
Copied
Arrow
                https://api.ocamba.com/v2/adex/conversion-events

Returns a list of Conversion events

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


Example: id=12345
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ events ]
An array of all created items.
Conversion Events
Name
Description
company_idstring
Company ID


Example: 6197120
conversionobject
The conversion object to which the event is connected
conversion_idstring
The ID of the conversion to which the event is connected.


Example: 13694
create_timedateTime
Timezone: GMT.


Example: 2021-10-29 15:40:10
full_namestring
Event name


Example: Direct purchase
idstring
Event ID


Example: 2209735596
namestring
Name of the event


Example: purchase
partnerstring
Partner of the event


Example: Direct
systemnumber
Differentiates if the event was created by a User or a Microservice.


Example: 0
update_timedateTime
Timezone: GMT.


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


Example: 38
tip
1 Searchable fields are name, partner and full_name.
2 Sortable fields are name, partner, full_name and create time (default descending).
3 To get the conversion object, pass conversion_id and conversion fields query or 'full' in the view query.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 38,
  "items": [
    {
      "id": "2209735596",
      "company_id": "6197120",
      "full_name": "Direct purchase",
      "partner": "direct",
      "name": "purchase",
      "system": 1,
      "create_time": "2023-07-31 07:24:30",
      "update_time": "2023-07-31 07:39:59"
    },
    {
      "id": "3906665649",
      "company_id": "6197120",
      "full_name": "Appsflyer test",
      "partner": "appsflyer",
      "name": "test",
      "system": 0,
      "create_time": "2023-08-01 11:55:10",
      "update_time": "2023-08-01 11:56:03"
    }
  ]
}

{
  "total": 38,
  "items": [
    {
      "id": "2209735596",
      "company_id": "6197120",
      "conversion_id": "13694",
      "full_name": "Direct purchase",
      "partner": "Direct",
      "name": "purchase",
      "system": 0,
      "create_time": "2021-10-29 15:40:10",
      "update_time": "2021-10-29 15:40:10"
    }
  ]
}