Reports & Insights

For how this area works day to day, see the Reports & insights guide.

Webhook events: alert.triggered, recommendation.created Planned. See Webhooks.

All paths are relative to /api/v1. Key is the scope an integration key needs, People the permission a signed-in person or personal key needs, and Feature the feature switch the endpoint belongs to. See how to read this reference.

• GET/alert-rules

  List alert rules

  Keyreports:read

  Peoplereports.read

  Featureinsights
• POST/alert-rules

  Create an alert rule

  Keyreports:write

  Peoplealerts.manage

  Featureinsights
• GET/alert-rules/{id}

  Get an alert rule

  Keyreports:read

  Peoplereports.read

  Featureinsights
• PATCH/alert-rules/{id}

  Update an alert rule (partial)

  Keyreports:write

  Peoplealerts.manage

  Featureinsights
• DELETE/alert-rules/{id}

  Archive an alert rule

  Keyreports:write

  Peoplealerts.manage

  Featureinsights
• GET/kpis

  Headline KPIs for a date range

  Keyreports:read

  Peoplereports.read

  Featureinsights
• GET/recommendations

  Recommended actions

  Keyreports:read

  Peoplerecommendations.read

  Featureinsights.recommendations
• GET/reports

  List the available reports

  Keyreports:read

  Peoplereports.read

  Featureinsights
• GET/reports/{key}

  Run a report

  Keyreports:read

  Peoplereports.read

  Featureinsights