Skip to main content
SmartRecruiters

Reporting API

Requires:
  • SmartRecruit
  • +
  • SmartConnect

 

The Reporting API allows companies to retrieve reports metadata, as well as the report data contained within custom reports built in Report Builder. Customers can programmatically download data extracts or build BI (Business Intelligence) integrations for reporting and analysis.

This API replaces the existing Analytics API and data services.

The Analytics API endpoints will be deprecated on Feb 28th, 2019.

Reporting API Endpoints 

 

Endpoint Description
GET /reports Returns a list of reports for a customer with such information as: report ID, report name and scheduling
GET /reports/{reportId} Returns information for a single report, including: report ID, report name and report definition. Does not include the list of report files generated from this report.
GET /reports/{reportId}/files

Returns all report files generated from the given report. Results can be filtered by file status status: RUNNING, PENDING, COMPLETED. Report files are ordered by their scheduling date.

Users can specify an optional parameter that will limit number of report files returned (by default return last 10).

GET /reports/{reportId}/files/{reportFileId}

Returns the following information for a Report file:

  • Status
  • User
  • Employee ID who requested report generation
  • Start generation Timestamp
  • Request generation Timestamp
  • Completed generation Timestamp
  • Status of Report file generation
GET /reports/{reportId}/files/{reportFileId}/data Returns actual data in the Report file in CSV format.
GET /reports/{reportId}/files/recent/data Returns the data for the most recently generated report file with status COMPLETED.

 

FAQ

Can I get data from the Reporting API directly to a data visualization software?

Yes, you can! Currently we support direct integration with Tableau via the Web Data Connector. Here is a handy guide on how to set it up. You can also manually import reports built with our internal Report Builder with this integration.

I seem to be having trouble with the Tableau Web Data Connector (WDC). What can I do?

If you are experiencing errors when using Tableau's WDC to feed data from our Reporting API to your Tableau analytics suite, such as whitelisting or data sync problems, please ensure you have followed Tableau's set up documentation accordingly, and get in touch first with Tableau support, as this feature is not owned or maintained by SmartRecruiters. If problems persist and found not to be caused by a misconfiguration of the WDC, please get in touch with our technical support for further assistance.