Skip to main content
GET
https://api.calmyx.com
/
v2
/
session
/
status
Session Status
curl --request GET \
  --url https://api.calmyx.com/v2/session/status \
  --header 'Authorization: <authorization>'
{
  "status": "PROCESSING",
  "progress": {
    "total": 50,
    "processed": 25,
    "successful": 24,
    "failed": 1
  },
  "submitted_at": "2025-01-15T10:30:00.000000",
  "started_at": "2025-01-15T10:30:05.000000",
  "completed_at": null
}

​
Overview

The Session Status API allows you to monitor the progress of an asynchronous quietness calculation session. Use this endpoint to check if your batch processing has completed.
To obtain an API key, please contact our sales team.

​
Authorization

​
Authorization
string
required
Your API key for authentication

​
Query Parameters

​
session_id
string
required
The unique session identifier returned from the Create Session endpoint
{
  "status": "PROCESSING",
  "progress": {
    "total": 50,
    "processed": 25,
    "successful": 24,
    "failed": 1
  },
  "submitted_at": "2025-01-15T10:30:00.000000",
  "started_at": "2025-01-15T10:30:05.000000",
  "completed_at": null
}

​
Response Fields

FieldTypeDescription
statusstringCurrent status: PENDING, PROCESSING, COMPLETED, or FAILED
progress.totalintegerTotal number of geolocations in the session
progress.processedintegerNumber of geolocations processed so far
progress.successfulintegerNumber of successful calculations
progress.failedintegerNumber of failed calculations
submitted_atstringTimestamp when the session was created
started_atstringTimestamp when processing started (null if not started)
completed_atstringTimestamp when processing completed (null if not completed)

​
Status Values

StatusDescription
PENDINGSession is queued and waiting to be processed
PROCESSINGSession is currently being processed
COMPLETEDAll geolocations have been processed
FAILEDSession processing failed

​
Notes

  • Poll this endpoint periodically to check the status of your session
  • A session is complete when status is COMPLETED or when progress.processed equals progress.total
  • The completed_at field will be null until the session finishes
  • Failed calculations are typically due to invalid coordinates or temporary processing errors