Skip to main content
Get the data behind your organization’s Analytics dashboard with GET /analytics.

Sandbox

Start with fictional data using your organization API key, available in Organisation settings. Your organization needs at least one recruiter; production API access and analytics access are not required. Set COLLECTIVE_API_KEY in your terminal or server environment, then make a request:
The sandbox returns four fictional recruiters, including one with no activity. Use IDs from its recruiters array to filter requests; real recruiter IDs are rejected. Fixed UTC dates give repeatable results.

Production

Ask support@collective.work to enable production API access and analytics access, then switch the URL to:
Production returns your organization’s data. Use the recruiter IDs from its response when filtering.

Choose your report

By default: all recruiters, all sections, daily totals, last 30 UTC calendar days including today. Match IDs to names using recruiters; see the resolved filters in metadata.filters. Inactive recruiters, including former members still attached to the organization, remain in the results with zero counts where appropriate. Usage counts events; activity counts distinct UTC days. Multiple events on one day count as one active day. Overall activity combines days across Sherlock, searches, jobs, and messages.
  • Recruiters: repeat recruiterIds to select multiple people.
  • Sections: repeat sections, for example sections=usage&sections=engagement. Only selected sections are returned.
  • Dates: choose a preset range, or use range=CUSTOM with inclusive UTC from and to dates (YYYY-MM-DD).
  • Grouping: set breakdown to DAILY, WEEKLY, MONTHLY, or YEARLY.
Weeks start on Monday; months and years start on their first day. A first bucket may start before your range, but only events within the requested dates count. Dashboard dates selected in a local timezone can differ from these UTC dates.
Requests that are too complex are rejected. Shorten the timeframe, or adjust the filters or breakdown as indicated by the error message.
See Get Analytics for parameters, metric definitions, and responses.