Skip to main content
POST
Aggregate activities
Beta: this endpoint may change or be removed without notice while in beta. There is no compatibility promise until it reaches general availability.

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Body

application/json
group_by
enum<string>[]
required

1-3 distinct dimensions in response order. This dimension enum may grow.

Required array length: 1 - 3 elements
Available options:
ACTIVITY_TYPE,
SUBJECT_TYPE,
ACTOR_TYPE,
USER_ACTOR
start_at
string<date-time>
required

Inclusive window start; the window may not exceed 92 days.

end_at
string<date-time>
required

Inclusive window end; the window may not exceed 92 days.

time_bucket
enum<string>

Optional UTC histogram. Empty time buckets are not zero-filled.

Available options:
DAY,
WEEK,
MONTH
activity_types
enum<string>[]
Maximum array length: 100
Available options:
TASK_CREATED,
TASK_ASSIGNED,
CANDIDATE_AVAILABILITY_REQUESTED,
CANDIDATE_AVAILABILITY_SUBMITTED,
SELF_SCHEDULE_REQUESTED,
SCHEDULE_CREATED,
SCHEDULE_UPDATED,
SCHEDULE_RESCHEDULED,
SCHEDULE_CANCELED,
SELF_SCHEDULE_CREATED,
SELF_SCHEDULE_RESCHEDULED,
SELF_SCHEDULE_CANCELED,
INTERVIEWER_RSVP_ACCEPTED,
INTERVIEWER_RSVP_DECLINED,
INTERVIEWER_RSVP_TENTATIVE,
CANDIDATE_RSVP_ACCEPTED,
CANDIDATE_RSVP_DECLINED,
CANDIDATE_RSVP_TENTATIVE,
COMMENT,
INTERVIEWER_AUTO_REPLACED,
CANDIDATE_INTERVIEW_REMINDER_SENT,
CANDIDATE_SELF_SCHEDULE_REMINDER_SENT,
CANDIDATE_AVAILABILITY_REMINDER_SENT,
SCHEDULE_INTERVIEW_ADDED,
SCHEDULE_INTERVIEW_UPDATED,
SCHEDULE_INTERVIEW_CANCELED,
DEBRIEF_CREATED,
DEBRIEF_CANCELED,
DEBRIEF_UPDATED,
DEBRIEF_RESCHEDULED,
CHANGE_REQUESTED,
FLAG_RESOLVED_CHANGE_REQUESTED,
FLAG_RESOLVED_INTERVIEW_DECLINED,
FLAG_RESOLVED_DEBRIEF_DECLINED,
FLAG_RESOLVED_CANDIDATE_DECLINED,
FLAG_RESOLVED_INTERVIEWER_DEACTIVATED,
FLAG_RESOLVED_INTERVIEWER_TENTATIVE,
FLAG_RESOLVED_DEBRIEF_ATTENDEE_TENTATIVE,
FLAG_RESOLVED_DEBRIEF_ATTENDEE_DEACTIVATED,
FLAG_RESOLVED_CANDIDATE_TENTATIVE
subject_types
enum<string>[]
Maximum array length: 100
Available options:
TASK,
APPLICATION,
CANDIDATE
actor_types
enum<string>[]
Maximum array length: 100
Available options:
USER,
CANDIDATE,
SYSTEM
user_actor_ids
string[]

Public user ids. Unknown or foreign-organization ids match no rows.

Maximum array length: 100

an user ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:usr_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
limit
integer

Response

Success

buckets
object[]
required
truncated
boolean
required