RErecruitwithatlas
Views

Create a metrics view

Changed on

Creates a dashboard owned by your API key's user. visibility defaults to public and isCollaborative to false. Every ID in metricsCard and metricsColumn is a metrics registry row ID and must exist in your agency — read an existing view first and copy the IDs it uses.

post/api/v1/metrics-views

Request

Request body

namestring required

View name

descriptionstring

Free-text description

visibility'public' | 'team' | 'private'

Who can see the view — owner only

isCollaborativeboolean

Whether anyone who can see the view may change it. Members of the view's team can change it either way

timeFrame'Today' | 'Yesterday' | 'This week' | 'Last week' | 'This month' | 'Last month' | 'This quarter' | 'Last quarter' | 'This year' | 'Last year' | 'Last 30 days' | 'Last 90 days' | 'Last 180 days' | 'All time' | 'null' nullable

Named relative period the dashboard defaults to

fromstring date-time nullable

Start of a fixed date range. Ignored when timeFrame is set

tostring date-time nullable

End of a fixed date range. Ignored when timeFrame is set

teamsToFilterstring[]

Team IDs the dashboard is scoped to

usersToFilterstring[]

User IDs the dashboard is scoped to

metricsCardstring[]

Metrics registry row IDs shown as cards. Unknown IDs are rejected with 400

teamIdstring uuid nullable

Team the view belongs to. IDs outside the agency are rejected with 400

refreshRateinteger

Auto-refresh interval in seconds. 0 disables it

Example request

{
  "name": "Q1 recruiter performance",
  "visibility": "team",
  "sorting": [
    {
      "id": "placements",
      "direction": "DESC"
    }
  ],
  "timeFrame": "Last 30 days"
}

Response

Metrics view created

status'ok' required

Changes