Your requests needs the following headers:

• Date: Timestamp in ISO 8601
• Authorization: See below
• Content-md5: md5 hash of the body request
• Content-type: application/json

Authorization header

All requests must include HTTP Authorization header with correct signature. The header is valid for 15 minutes, based on given timestamp.

Format of the HTTP Authorization header:

REALM USERID:SIGNATURE

Computing signature

Signature is generated using HMAC with SHA-256 algorithm.

The key for HMAC is the REST user password and the message is constructed in the following way:

• Every item on it's own line, add to the string:
  • Request method: POST.
  • Content MD5: The same as in the Content-md5 header.
  • Content Type: The same as in the Content-Type header, being application/json.
  • Date: The same timestamp as in the Date header.
  • Content: The full body content.
  • Path: The path part of the URI, including any query parameters.

Example:

POST
b41c090e9b32a3f85c631db1af38b0af
application/json
2099-01-01 00:00:00+0200
{"ping":"pong"}
/rest/v1/pingpong

HMAC_SHA256("password", message)
= d0e9d4895b0a06e19623b6c63cf6b173d9fa8ca3427ccb680c22209b90d7bb5e

Error responses

Failure of providing the correct headers and authentication can result in the following errors. Note that the HTTP response code remains 200 OK.

"message": "RESTv1 unauthorized login attempt: Checksum does not match!"

The body checksum calculated on the server does not match the header Content-md5

"message": "RESTv1 unauthorized login attempt: User not valid!"

An invalid user was provided. Check if you provided the correct USERID.

"message": "RESTv1 unauthorized login attempt: Hash mismatch!"

The signature part of the authorization header does not match the calculated signature by the server. Possibly a wrong API key or other variable was used when calculating the signature

{"message":"Not found","status":404,"status_message":"Not Found"}

Either a wrong url or REALM was used when making the API call.

Test connection

Import events

Query database

Export data

Segment management