---
title: "Retrieve Engagement Overview"
method: GET
path: "/v2/company/{company_id}/locations/{location_id}/engage_overview"
tags: ["Engage"]
---

# Retrieve Engagement Overview

`GET /v2/company/{company_id}/locations/{location_id}/engage_overview`

## Request

- Base URL: `https://api.7shifts.com`
- URL: `https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/engage_overview`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://app.7shifts.com/oauth2/authorize`
    - Client credentials
    - Password
    - Token URL: `https://app.7shifts.com/oauth2/token`
  - API key in cookie `7session`

## Path parameters

- `company_id` integer, required
- `location_id` integer, required

## Query parameters

- `date` string, required
- `frequency` 'week' | 'month'
- `user_type` 'employees' | 'managers' | 'assistant_managers'
- `permission_template_id` integer

## Headers

- `x-api-version` string: An API version
- `x-company-guid` string, uuid

## Response `200`

OK

- object
  - `object` 'engage_overview', required
  - `data` object, required
    - `location_stats` object, required
      - `lates` object, required
        - `current` integer, required
        - `previous` integer, required
      - `no_shows` object, required
        - `current` integer, required
        - `previous` integer, required
      - `sick_shifts` object, required
        - `current` integer, required
        - `previous` integer, required
      - `shift_bids` object, required
        - `current` integer, required
        - `previous` integer, required
      - `shift_drops` object, required
        - `current` integer, required
        - `previous` integer, required
    - `employee_stats` object, required
      - `most_reliable` object, required
        - `id` integer, required
        - `first_name` string, required
        - `last_name` string, required
        - `photo_url` string, required
        - `primary_role` string, nullable, required
      - `most_eager` object, required
        - `id` integer, required
        - `first_name` string, required
        - `last_name` string, required
        - `photo_url` string, required
        - `primary_role` string, nullable, required
      - `most_sick` object, required
        - `id` integer, required
        - `first_name` string, required
        - `last_name` string, required
        - `photo_url` string, required
        - `primary_role` string, nullable, required
      - `most_late` object, required
        - `id` integer, required
        - `first_name` string, required
        - `last_name` string, required
        - `photo_url` string, required
        - `primary_role` string, nullable, required
      - `most_drops` object, required
        - `id` integer, required
        - `first_name` string, required
        - `last_name` string, required
        - `photo_url` string, required
        - `primary_role` string, nullable, required
    - `engagement_scores` object, required
      - `most_engaged` object[], required
        - `user` object, required
          - `id` integer, required
          - `first_name` string, required
          - `last_name` string, required
          - `photo_url` string, required
          - `primary_role` string, nullable, required
        - `current_score` integer, required
        - `metrics` object, required
          - `shift_bids` object, required
            - `stat` integer, required
            - `ranking` integer, required
          - `dropped_shifts` object, required
            - `stat` integer, required
            - `ranking` integer, required
          - `no_shows` object, required
            - `stat` integer, required
            - `ranking` integer, required
          - `lates` object, required
            - `stat` integer, required
            - `ranking` integer, required
          - `total_shifts` integer, required
      - `least_engaged` object[], required
        - `user` object, required
          - `id` integer, required
          - `first_name` string, required
          - `last_name` string, required
          - `photo_url` string, required
          - `primary_role` string, nullable, required
        - `current_score` integer, required
        - `metrics` object, required
          - `shift_bids` object, required
            - `stat` integer, required
            - `ranking` integer, required
          - `dropped_shifts` object, required
            - `stat` integer, required
            - `ranking` integer, required
          - `no_shows` object, required
            - `stat` integer, required
            - `ranking` integer, required
          - `lates` object, required
            - `stat` integer, required
            - `ranking` integer, required
          - `total_shifts` integer, required
    - `shift_feedback` object, required
      - `current` number, nullable, required
      - `previous` number, nullable, required
    - `tenure` object, required
      - `average_tenure` integer, nullable, required

## Other responses

- `400`: Not found
- `401`: Unauthorized
- `403`: Forbidden
- `500`: Server Error

---

[API](https://skmtc.dev/7shifts/apis/7shifts-api.md) - [All operations](https://skmtc.dev/7shifts/apis/7shifts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/7shifts/apis/7shifts-api/revisions/40e0ef40dfcd?raw)