User limits & reporting

Users & Limits

The API supports usage tracking for organizations and users of the API client. This is implemented through headers that should be included in API requests. You can use any user or organization ID you prefer. These IDs are crucial for generating reports, so choose meaningful identifiers for easy tracking.

When fetching scores from an API call you have to include the header in your request:

"X-User-Id": "your_user_unique_identifier"

For easier tracking on an organizational level, you can also include the following header:

"X-Organization-Id": "your_organization_unique_identifier"

Once these parameters are provided, the API will:

1. Track usage against your license limits based on:

   • Number of unique users

   • Number of distinct datasets accessed

   • Number of indicators requested

2. Generate automated usage reports that are accessible through your account dashboard

3. Apply the appropriate usage limitations as defined in your license agreement