Aggregate Projects

post

https://developer.beta.salussafety.io/v1/project/aggregate

Aggregate projects with GROUP BY operations.

Allows grouping by name, city, country, site_code, and other fields with aggregation functions like COUNT, SUM, AVG, MIN, MAX. Uses the same base filters and company scoping as the search endpoint for consistent behavior.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Project aggregation model with project-specific filters.

Inherits from ProjectSearchModel to include is_archived and external_ids filters in addition to the standard search parameters.

query

string | null

Keywords should be space separated and are ANDed together, so all keywords must be present but they can be present in any of the fields specified above.

skip

integer | null

Defaults to 0

Number of records to skip before returning records

limit

integer | null

Defaults to 50

Number of records to return

sort_direction

string

enum

Defaults to desc

Direction to sort the sort_column - ascending or descending

Allowed:

date_start

date-time | null

If sorting on updated_at or created_at, and date_cut_off is provided, return only records that were created or updated (whichever is being sorted on) between date_start and date_cut_off

date_cut_off

date-time | null

If sorting on updated_at or created_at, return only records that were created or updated (whichever is being sorted on) between the initial value (determined by sort order) and the cutoff date.

For example, sorting on created_at ascending with a date_cut_off will return all records from the oldest creation date to the cutoff date. By comparison, sorting on created_at descending with a date_cut_off will return all records from the most recent creation date to the cutoff date.

sort_column

string | null

Column to sort aggregation results by (must be in group_by or an aggregation alias)

external_ids

string | null

Return sites with a matching external identifier. Should be a comma-separated list.

is_archived

boolean | null

Defaults to false

Filter based on the project's archived status. Defaults to False, which returns records that have not been archived

city

string | null

Filter by project city.

country

string | null

Filter by project country.

is_private

boolean | null

Filter by private/public status.

prime_id

integer | null

Filter by prime contractor company ID.

group_by

array of strings

required

Column names to group by

Group By*

aggregations

array of objects

required

Aggregation functions to apply

Aggregations*

date_filter_column

string

enum

Defaults to updated_at

Column to apply date_start/date_cut_off filters on (created_at or updated_at)

Allowed:

Responses

200Successful Response

400Invalid aggregation request

403Permission denied

409Integrity Error or Data Conflict

422Validation Error