Get Data from Dataset

Use this resource to request data from the specified dataset. You must specify a list of fields to show on the report. The list of fields is available here at /api/v1/datasets/{datasetName}/fields.

Field Settings:

Show History When any of the fields included in your request are historical table fields, you may include the "showHistory" setting. Example: "showHistory":["entityName"]. Entity Name can be found in the get /api/v1/datasets/{datasetName}/fields endpoint.

Sort By: You can pass multiple fields to sort by as an array of objects {field: "fieldName", sort: "asc,desc"}. The order of the fields in the array will determine the order of the sort.

Group By: Group By is passed as an array of strings but currently grouping by more than one field is not supported.

Aggregations: When using aggregations the following aggregates are available based on field type:

• text
  • count
• date
  • count
  • min
  • max
• int
  • count
  • min
  • max
  • sum
  • avg
• bool
  • count
• options
  • count
• ssnText
  • count

Filters: When using filters, the filtered field does not have to be in the list of fields you want to show on the report.

Important Filter Notes:

• List filter values (for "options" field type using "includes" or "does_not_include" operators) must be enclosed in square brackets [ ]. Example: ["value1", "value2"]
• Future hires: Future hires have a status of "Inactive" in the datasets API. To include future hires in your results, you must include "Inactive" in your status filter.

Use the /api/v1/datasets/{datasetName}/field-options endpoint to retrieve possible filter values for fields. Use the "id" returned from the field-options endpoint.

Filter Operators by Field Type:

• text
  • contains
  • does_not_contain
  • equal
  • not_equal
  • empty
  • not_empty
• date
  • lt (less than)
  • lte (less than or equal)
  • gt (greater than)
  • gte (greater than or equal)
  • last - Uses an object for the value: {"duration": "5", "unit": "years"}. Unit can be "days", "weeks", "months", or "years". Duration is a number as a string.
  • next - Uses an object for the value: {"duration": "5", "unit": "years"}. Unit can be "days", "weeks", "months", or "years". Duration is a number as a string.
  • range - Uses an object for the value: {"start": "2023-01-01", "end": "2023-12-31"}. Dates must be in YYYY-MM-DD format.
  • equal
  • not_equal
  • empty
  • not_empty
• int
  • equal
  • not_equal
  • gte
  • gt
  • lte
  • lt
  • empty
  • not_empty
• bool
  • checked
  • not_checked
• options
  • includes
  • does_not_include
  • empty
  • not_empty
• ssnText:
  • empty
  • not_empty