Endpoints - Management - Datapoints

Datapoints

 

Model

A datapoint (either tracking link or tracking pixel) is the basic entity you use 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 datapoint.

Datapoint Model

 

GET /datapoints

Retrieve a list of datapoints 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 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



GET /datapoints/count

Retrieve a count of the datapoints 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 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

 

POST /datapoints

Create a datapoint for the current authenticated user.

Input: Datapoint (one without id)

Result: EntityURI (uri of the newly created datapoint)

 

GET /datapoints/{id}

Retrieve the datapoint {id} for the current authenticated user.

Result: Datapoint

 

DELETE /datapoints/{id}

Delete the datapoint {id} for the current authenticated user.

Result: EntityURI

 

POST /datapoints/{id}

Update the datapoint {id} for the current authenticated user.

Input: Datapoint (the one you fetched from GET /datapoints/{id} with your modifications)

Result: EntityURI

 

POST /datapoints/batch

Create datapoints in batch by posting.

Input: DatapointList (See details here)

Result: BatchList a list of BatchResult objects that contains the posted Datapoints with an optional EntityURI or BatchError to know the result of the operation.

 

DELETE /datapoints/batch

Delete datapoints in batch by sending a request.

Input: EntityURIList

Result: BatchList a list of BatchResult objects that contains the posted Datapoints with an optional EntityURI or BatchError to know the result of the operation.

 

PUT  /datapoints/batch

Update datapoints in batch by sending a request.

Input: DatapointList (as for POST endpoint but with full Datapoint object)

Result: BatchList a list of BatchResult objects that contains the posted Datapoints with an optional EntityURI or BatchError to know the result of the operation.

 

For more info read this FAQ: 

Have more questions? Submit a request

0 Comments

Article is closed for comments.