Work with Analytics Endpoints

This page provides information necessary to invoke analytics endpoints.

License Requirements

In order to use the Analytics API, your tenant must be enabled with the events_collector_standalone entitlement. The license to use the Analytics API is bundled with the Analytics for CSS entitlement but not with the "Standard" (CIS only) tenant entitlement.

Endpoint URL

The Analytics API base endpoint is same as the base endpoint of the Analytics Portal. For example, if the URL for the Analytics Portal is https://lg602-my-kibble.centrify.io/analytics then the Analytics API base endpoint is https://lg602-my-kibble.centrify.io.

Analytics Authentication

Analytics API requests must be authenticated by providing a bearer token in the request header. For example:

Authorization: Bearer ABC12343...

Creating and Maintaining an Analytics API Access Token

Create an access token for use with the Analytics endpoints by invoking the /apis/access_tokens endpoint:

POST https://mytenant.centrify.io/analytics/services/v1.0/apis/access_tokens 

{
   "name":"Test 101",
   "expiration_time":1529006108650,
   "scopes":[  
      "sensor_registration",
      "content"
   ]
}

The token field in the response contains the access token:

{  
   "id":"c454fb8...",
   "name":"Test 101",
   "user_name":"demoabc",
   "token":"eyJhbGciOiJIUzI...",
   "status":"active",
   "expiration_time":1529006108650,
   "creation_time":1527879324266,
   "scopes":[  
      "sensor_registration",
      "content"
   ]
}

You can use the token value when invoking subsequent Analytics endpoints and also to activate, deactivate, and revoke access tokens.

Try the API in Postman:
Try the API in Postman.
Click here for help with using our sample Postman collection.