Overview

To use ClickMeter API the user should use the endpoints available at the domain: https://apiv2.clickmeter.com

 

All API calls require authentication credentials: this can be retrieved in the page http://my.clickmeter.com/api-key and must be sent with all requests as an header called X-Clickmeter-Authkey.

 

The allowed HTTP verbs are: GET, PUT, POST and DELETE. The server supports also an OPTION verb to be compliant with CORS specifics about allowed headers.

 

In case of POST / PUT usually the argument(s) go into the body of the request (usually a JSON, so setting the Content-type to application/json is manadatory in some clients or the server will not understand the request).

 

All API endpoints, otherwise specified, use JSON as input and output.

 

API endpoints are grouped in main sections, these sections are:

  • Management: dedicated to creation/editing/removal of datapoints (links and pixels), groups, tags, conversions and domains

  • Accounting: dedicated to management of your account and permissions for guests users

  • Aggregated: delivers statitistics about your datapoints, groups, conversions and global

  • Reports: delivers TOP reports on your datapoints, groups and global

  • Clickstream & Hits List: delivering details in real time or about the pasts on the clicks received by your datapoints, groups and conversions

 

There is a complete list in the API toolbox: http://www.clickmeter.com/apitoolbox

 

Some API endpoints have filters that can be used to change the behaviour to retrieve a diferent result: if present they’re specified with the syntax:

name [required / optional] [type, default value] : description

 

An endpoint will answer with HTTP 200 if the call was successfull, otherwise errors like 403 and 404 are used in case of forbidden operation or endpoint/entity not found or errors like 500 and 501 in case of processing errors.

 

The standard error answer you can expect is JSON based is modelled like

{

 "errorCode": "...",    // An internal error code, for support

 "httpErrorCode": "...",    // HTTP error code

 "Message": "..."        // A human readable message
}

 

Common models

Some models are used in many common answers, in particular when we need to produce a list of entities and a link to them we always use the following:

 

EntityURIList {

entities (array[EntityURI]): A list of entities

}

EntityURI {

id (integer): Id of the entity,

uri (string): URI of the resource, local to the API server,

name (string, optional): An optional description of the entity

}

 

When answering to a count request the entity used for answer is the following

 

CountObject {

count (integer): The count of the requested resource

}

 

 

 

For more info read this FAQ: 

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.