SMsmartrecruiters
reports

Generate ad-hoc report

Use this endpoint to generate ad-hoc report. NOTE: Report files are generated asynchronously. Ensure the report file status is: COMPLETED before fetching the data. To check the report file status use the GET /reports/{reportId}/files/recent endpoint.

post/reports/{reportId}/files

Request

  • Base URL
    https://api.smartrecruiters.com/reporting-api/v201804
  • URL
    https://api.smartrecruiters.com/reporting-api/v201804/reports/{reportId}/files
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Client credentials
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: reporting_write

Path parameters

reportIdstring required

Report identifier

Response

Successful response.

reportFileIdstring
reportIdstring
reportFileStatus'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED'
scheduleType'AD_HOC' | 'SCHEDULED'
schedulingDatestring date-time
generationDatestring date-time
requestorIdstring
accessGroupIdstring
systemRoleIdstring
rowEntityTypeIdstring
rowEntityInstanceIdstring
errorReason'UNKNOWN' | 'MISSING_ACCESS_GROUP' | 'ACCESS_GROUP_MISMATCH' | 'MISSING_SYSTEM_ROLE' | 'SYSTEM_ROLE_MISMATCH' | 'REPORTING_AREA_RESTRICTED' | 'INCORRECT_ACCESS_CONFIGURATION' | 'MISSING_REPORT_CREATOR_EMPLOYEE' | 'MAX_REPORT_FILE_SIZE_EXCEEDED'

Changes

No recorded changes to this operation across all 1 revision of this API.