All Supervisor Reports API endpoints are deprecated as of November 2016.
All Supervisor Reports API endpoints are deprecated as of November 2016. Use the Analytics Reports API instead.
The Supervisor Reports API (also referred to as the Reporting API) allows you to generate and retrieve any of the available CSV reports.
Supervisor Reports API authentication
All endpoints require HTTP Basic Authentication. Create a dedicated API user account and contact Khoros Support to request Analytics API access be granted for that user account.
Important
The deprecated Supervisor Reports endpoints use a different API user account than the API user account used with HTTP Basic Authentication. If using the deprecated endpoints, be sure that you are using the Reporting API Username displayed in Configuration Dashboard > General Settings.
| Endpoint | Deprecation Date |
|---|---|
| GET /reports/csv/reportName | November 2016 |
| GET /reports/csv_long/reportName | November 2016 |
| GET /reports/list | November 2016 |
| GET /api/reports/csv/reportName | September 2016 |
| GET /api/reports/csv_long/reportName | September 2016 |
| GET /api/reports/list | September 2016 |
Important
The calls deprecated in September 2016 and the calls deprecated in November 2016 use the same call format and provide the same output. The difference between the two sets of calls is the path and the user account used for HTTP authentication. We strongly recommend that any customers still using the Supervisor Report API update integrations and customizations to use the November 2016 paths and update the API account user account making calls to those endpoints.