Comeet offers several ways to sync data from Comeet to your BI tool to build your own custom dashboards and reports. These options are included as part of Comeet's Enterprise plan.
This guide explains how to use the Recruiting API to pull data for reporting purposes, which is one of the ways to retrieve data. For an overview of your options and to see which one is right for you please see our getting started guide.
Please follow these guidelines for retrieving data for reporting purposes using the Recruiting API:
- Create a database to which the data from Comeet will be synced. Create a table for each of the data types listed below.
- Create a process that will run periodically (ie. every 5 minutes) to retrieve the latest changes to the data and update your data incrementally. This means that each execution of the update process will retrieve the objects that were changed since the last update.
- Note that the lists returned from the API use pagination. This means that the update process that you build must make multiple requests, iterating through all pages of results, to retrieve all updated data.
- When making requests, define filters using two timestamps: use the time of the last successful update process as the lower limit and the current time stamp (in the beginning of the execution of the update process) as the upper limit. See the list of data types below to learn which time filter to use for each endpoint.
- Use the objects' UID as a unique identifier to identify whether you need to update an existing item in your database or create a new one.
- Note that some of the data types are provided within other objects. For example: Completed steps and Current steps are provided within the Candidate object. Refer to the data types below for more details.
Do not attempt to retrieve all company data on every execution of the update process. This is not possible due to the requests limit.
Create a database for saving the data retrieved from Comeet. See the following list for the data types and how to retrieve each one.
- Retrieve data: use the endpoint List All Candidates
- Time filter: set
time_hiring_process_updated:afterto the time of the last successful execution of the update process and
time_hiring_process_updated:beforeto the start time of the current execution.
- Retrieved data: Steps are retrieved as part of the Candidate object. Save the step objects in the
future_stepsproperties. Make sure to save a property that indicates whether a step is completed, current or future.
- Retrieve data: use the endpoint List All Positions
- Time filter: set
time_last_updated:afterto the time of the last successful execution of the update process and
time_last_updated:beforeto the start time of the current execution.
- Retrieved data: Sources are retrieved as part of the Candidate object in the