Conversions
Model
A conversion is an entity used to track your conversion related to one or many Datapoints in ClickMeter, this is the model represented through JSON for API interaction. Some fields are maked as optional as in they don’t need to be present in a minimum working conversion.
GET /conversions
Retrieve a list of conversions associated to the current authenticated user.
This endpoint has optional filters that can be used in the GET request to change its response behaviour.
Result: EntityURIList (see “Common models”)
Filters:
-
offset [optional] [integer, 0] : Where to start when retrieving conversions
-
limit [optional] [integer, 20] : Maximum elements to retrieve
-
createdBefore [optional] [string] : A date in the format YYYYMMDDHHmm that will filter by creation date of the conversion
-
createdAfter [optional] [string] : A date in the format YYYYMMDDHHmm that will filter by creation date of the conversion
-
name[optional] [string, all] : A pattern name expression. Example: twit*
-
status [optional] [string, all] : Status of the conversion, possible statuses are active, deleted, and all (all statuses)
GET /conversions/count
Retrieve a count of the conversions associated to the current authenticated user.
This endpoint has optional filters that can be used in the GET request to change its response behaviour.
Result: CountObject (see “Common models”)
Filters:
-
createdBefore [optional] [string] : A date in the format YYYYMMDDHHmm that will filter by creation date of the conversion
-
createdAfter [optional] [string] : A date in the format YYYYMMDDHHmm that will filter by creation date of the conversion
-
name[optional] [string, all] : A pattern name expression. Example: twit*
-
status [optional] [string, all] : Status of the conversion, possible statuses are active, deleted, and all (all statuses)
POST /conversions
Create a conversion for the current authenticated user.
Input: Conversion (one without id)
Result: EntityURI (uri of the newly created conversion)
GET /conversions/{id}
Retrieve the conversion {id} for the current authenticated user.
Result: Conversion
DELETE /conversions/{id}
Delete the conversion {id} for the current authenticated user.
Result: EntityURI
POST /conversions/{id}
Update the conversion {id} for the current authenticated user.
Input: Conversion (the one you fetched from GET /conversions/{id} with your modifications)
Result: EntityURI
GET /conversions/{id}/datapoints
Retrieve a list of datapoints associated to the current authenticated user for the conversion {id}.
This endpoint has optional filters that can be used in the GET request to change its response behaviour.
Result: EntityUriList (see “Common models”)
Filters:
-
offset [optional] [integer, 0] : Where to start when retrieving datapoints
-
limit [optional] [integer, 20] : Maximum elements to retrieve
-
createdBefore [optional] [string] : A date in the format YYYYMMDDHHmm thath will filter by creation date of the datapoint
-
createdAfter [optional] [string] : A date in the format YYYYMMDDHHmm thath will filter by creation date of the datapoint
-
type [optional] [string] : Type of datapoint to retrieve (TL is tracking link, TP is trackinge pixel)
-
status [optional] [string, all] : Status of the datapoint, possible statuses are active, deleted, paused, spam, deleted and all (all statuses)
-
tags [optional] [string] : A comma separated list of tags you want to filter by
PUT /conversions/{id}/datapoints/patch
Assign to the conversion {id} the datapoint specified in the input object.
Input: PatchRequest (see here )
Result: Conversion
For more info read this FAQ:
0 Comments