Job summary

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

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/jobs/summary

Path parameters

projectId*integer

Project ID

Query parameters

startDate*string (date-time)

Start date

endDate*string (date-time)

End date

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

summary*array of object

category*string

lengthMs*integer

Length per category in milliseconds

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/summary?startDate=2024-11-21T12%3A02%3A01.487Z&endDate=2024-11-21T12%3A02%3A01.487Z', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "summary": [
    {
      "category": "text"
    }
  ]
}

Job summary

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

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/jobs/summary

Path parameters

projectId*integer

Project ID

Query parameters

startDate*string (date-time)

Start date

endDate*string (date-time)

End date

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

summary*array of object

category*string

lengthMs*integer

Length per category in milliseconds

Request

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/jobs/summary?startDate=2024-11-21T12%3A02%3A01.487Z&endDate=2024-11-21T12%3A02%3A01.487Z', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text",
  "summary": [
    {
      "category": "text"
    }
  ]
}