Authenticate and access the Statistics Reporting Services API
Learn how to authenticate and access the Statistics Reporting Services API, including the required Gateway URL, authorization headers, and role-based access requirements.
Use the Statistics Reporting Services to retrieve reporting and monitoring data for a specific tenant. All requests must be authenticated and authorized before accessing any endpoint.
Authentication and authorization
The Statistics Reporting Services is protected behind the Reltio API Gateway and uses bearer token authentication. Access is granted only to users or systems that are properly authenticated and authorized.
The following requirements apply to all requests:
- A valid bearer token must be included in the
Authorizationheader. - The token must be associated with a user or system that has the
ROLE_STATISTICS_REPORTINGpermission. - Access is limited to the tenant specified in the access token.
Gateway URL
The Statistics Reporting Services is accessed through a dedicated API Gateway. The Gateway URL serves as the base URL for all Statistics Reporting API endpoints.
Production Gateway URL:
https://gprus-01-ssrv-statistics-reporting.reltio.com
All endpoint paths must be appended to this base URL using the following format:
https://gprus-01-ssrv-statistics-reporting.reltio.com/statistics-reporting/{tenantId}/API/{endpoint}
Replace:
{tenantId}with your Reltio tenant ID.{endpoint}with the specific API operation (for example,getDailyTaskUsage).
HTTP method and endpoint
Each Statistics Reporting API operation defines its own HTTP method and endpoint path. The general structure is:
{gatewayUrl}/statistics-reporting/{tenantId}/API/{operationName}
For example:
POST https://gprus-01-ssrv-statistics-reporting.reltio.com/statistics-reporting/{tenantId}/API/getDailyTaskUsage
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <accessToken>. For more information about generating access tokens, see Authentication API. | Yes |
| Content-Type | application/json (required for POST requests) | Yes (for POST) |
Example request
The following example shows how to send a request using curl to retrieve daily task usage statistics.
curl -X POST https://gprus-01-ssrv-statistics-reporting.reltio.com/statistics-reporting/{tenantId}/API/getDailyTaskUsage \
-H "Authorization: Bearer {access_token}" \
-H "Content-Type: application/json" \
-d '{
"from": 1704067200000,
"to": 1704153600000,
"env": "prod"
}'
env parameter specifies the hosted environment identifier for your tenant.
This value must exactly match the environment where your tenant is deployed (for example, 361, tst-01, na07-prod, or na07-test).
Do not use generic values such as dev, qa, or prod.
The endpoint retrieves data from the specific hosted environment you provide.
Error behavior
If the request is missing the Authorization header, contains an invalid or expired token, or the associated user does not have the required role, the API returns an error response.
Common HTTP status codes include:
401 Unauthorized— Missing or invalid access token.403 Forbidden— Authenticated user lacks theROLE_STATISTICS_REPORTINGpermission.404 Not Found— Incorrect endpoint path or tenant ID.