Following the instructions below, you can load TrueClicks data through REST API.
Prerequisites
Before using the API, ensure you have a TrueClicks data connector key:
Log in to TrueClicks and navigate to the Reporting page
Scroll down to the Data Connector section
Enter a key of your choice, and click the Create New Key
This process generates a Username and Token, which you’ll use later, for example, when integrating with Google Sheets, Looker Studio, or through REST API.
Accessing Data with OData API
TrueClicks data is primarily available through the OData API. OData (Open Data Protocol) is an ISO/IEC-approved and OASIS-standard protocol that simplifies the consumption of data via RESTful APIs.
Example:
Steps:
Open the URL in your browser
Enter your data connector username and token (as the password) in the credentials pop-up
Retrieve account-level aggregated results for all your accounts in JSON format
Available data sets in OData API
You can access the following datasets via OData API:
Data set | URL | Description |
Account-level data (current) | Latest aggregated account data, including scores, monitoring issues, and auditing results. | |
Account-level data (historical) | Same as above but includes weekly historical data for up to 1 year. | |
Check-level data (current) | Latest calculated score or value for every monitoring and auditing check. | |
User-level data | Information about active users and pending invitations. | |
Task-level data | Tasks from Task management | |
Target monitoring (active) | Details of currently running target monitoring periods. | |
Target monitoring (all) | Includes current, past, and future target monitoring periods. |
Check-level output table results
For checks with table outputs containing additional details, the REST API exposes this data instead of the OData API. Each check generates a unique schema.
Example:
Steps:
Replace the
accountId=123in the URL with your actual account ID (visible in the TrueClicks interface URL)Open the updated URL in your browser
If prompted, enter your data connector username and token as the credentials
Retrieve the output table in JSON format for the specified account and check
Key Parameters:
accountId - your account’s unique ID, found in the TrueClicks interface URL
ruleKey: The internal key for TrueClicks checksruleKey parameter - there are 2 ways you can retrieve the internal key for TrueClicks checks:
Retrieve this from the OData endpoint for check-level data (field: ruleKey).
Alternatively, convert the check name in the TrueClicks UI to camel-case format.
Example:urgent-broken-asset-url→Urgent_BrokenAssetUrl.
