---
title: "Job summary"
method: GET
path: "/api/{projectId}/jobs/summary"
tags: ["Jobs"]
---

# Job summary

`GET /api/{projectId}/jobs/summary`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/summary`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/jobs/summary/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a summary of jobs, grouped by key. Used to report to users how much compute they've used.

## Path parameters

- `projectId` integer, required

## Query parameters

- `startDate` string, date-time, required
- `endDate` string, date-time, required

## Response `200`

OK

- JobSummaryResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `summary` object[], required
    - `category` string, required
    - `lengthMs` integer, required: Length per category in milliseconds

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)