reports

Get report files

Use this endpoint to fetch a list of report files of a specific report. Report files are sorted by generation date (newer report files first).

Paging

Whenever there's more data to be returned, the nextPage property will contain an opaque identifier of the next page. The value can be then passed as a page query parameter in a subsequent request. Another option is to use the response's Link HTTP header, which contains a web link to the following page, example:

<https://api.smartrecruiters.com/reporting-api/v201804/reports/{reportId}/files?page=MjEyMy0wMS0wMVQwMDowMDowMC4xMjFaO2Q7MDg4MjY4MWItOTIzYi00ZTIwLWIwMDctY2Y0Y2I0YTM5ODRi>; rel="link"
get/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
    • OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Client credentials
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: reporting_read
    • or API key in header x-smarttoken

Path parameters

reportIdstring required

Report identifier

Query parameters

pagestring

Opaque page identifier to be returned.

limitinteger

Number of entities that should be returned per page.

Response

Successful response.

nextPagestring

Changes

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