Reporting Custom Field Values

Within higher licenses, you have the option to define your own fields (so-called custom fields), i.e., new data items on the candidate card. Learn more about the functionality here.

Example of custom fields on a candidate card:

If you want to report the values of these items, you have the following two options:

Within XLSX Report

You can export data for reporting in XLSX format in ATS Recruitis here. A new option "Custom Fields" has been added to the report menu, which creates a new worksheet with custom fields in the resulting Excel file.

Using API

Within the reports endpoint in the API, similar to the XLSX report, a new sheet called custom-fields has been added. An example of such a call is:

  • GET https://app.recruitis.io/api2/reports/?lists[]=custom-fields&date_from=2023-04-01&date_to=2023-07-01

The result is a JSON with format and content corresponding to the XLSX version mentioned above.

💡 Complete API documentation can be found here.

Reporting Principle

  • Custom fields reported also with the answer_id value (i.e., a specific response to a specific position) relate to a specific position, custom fields only with user_id relate to the applicant in general.
  • Only filled-in values are reported (i.e., not all fields are reported, but only those that have a value filled in).
  • Report data range:
    • For the data range, what matters is the creation of the entity to which the custom field relates, i.e.:
      • For fields only related to the user (i.e., only user_id is filled), it is the creation of the given user.
      • For fields related to a specific position (i.e., answer_id is also filled), it is the creation of the given response to the position.
    • Example - if the applicant was created on January 1st and the response to the position on March 1st, and I report from February 1st to April 1st, custom fields for the applicant will not be in the report, custom fields for the response will be in the report.