Session Status - Calmyx API Documentation

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
  },
  "results": [
    {
      "lat": 37.7749,
      "lng": -122.4194,
      "status": "success",
      "quiet_score": 72,
      "listing_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "analyzed_at": "2026-01-15T10:30:10.000000"
    },
    {
      "lat": 37.7849,
      "lng": -122.4094,
      "status": "failed",
      "error": "Failed to calculate quietness score",
      "analyzed_at": "2026-01-15T10:30:12.000000"
    }
  ],
  "submitted_at": "2026-01-15T10:30:00.000000",
  "started_at": "2026-01-15T10:30:05.000000",
  "completed_at": null
}

GET

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
  },
  "results": [
    {
      "lat": 37.7749,
      "lng": -122.4194,
      "status": "success",
      "quiet_score": 72,
      "listing_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "analyzed_at": "2026-01-15T10:30:10.000000"
    },
    {
      "lat": 37.7849,
      "lng": -122.4094,
      "status": "failed",
      "error": "Failed to calculate quietness score",
      "analyzed_at": "2026-01-15T10:30:12.000000"
    }
  ],
  "submitted_at": "2026-01-15T10:30:00.000000",
  "started_at": "2026-01-15T10:30:05.000000",
  "completed_at": null
}

Overview

The Session Status API allows you to monitor the progress of an asynchronous Quiet Score™ calculation session. Use this endpoint to check if your batch processing has completed and retrieve detailed results for each location.

To obtain an API key, register for an account and subscribe to a plan.

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
  },
  "results": [
    {
      "lat": 37.7749,
      "lng": -122.4194,
      "status": "success",
      "quiet_score": 72,
      "listing_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "analyzed_at": "2026-01-15T10:30:10.000000"
    },
    {
      "lat": 37.7849,
      "lng": -122.4094,
      "status": "failed",
      "error": "Failed to calculate quietness score",
      "analyzed_at": "2026-01-15T10:30:12.000000"
    }
  ],
  "submitted_at": "2026-01-15T10:30:00.000000",
  "started_at": "2026-01-15T10:30:05.000000",
  "completed_at": null
}

Response Fields

Field	Type	Description
`status`	string	Current status: `QUEUED`, `PROCESSING`, `COMPLETED`, or `FAILED`
`progress.total`	integer	Total number of locations in the session
`progress.processed`	integer	Number of locations processed so far
`progress.successful`	integer	Number of successful calculations
`progress.failed`	integer	Number of failed calculations
`results`	array	Array of location results (see below)
`submitted_at`	string	ISO 8601 timestamp when the session was created
`started_at`	string	ISO 8601 timestamp when processing started (null if not started)
`completed_at`	string	ISO 8601 timestamp when processing completed (null if not completed)

Results Array

Each item in the results array contains:

Successful Location

Field	Type	Description
`lat`	number	Latitude of the location
`lng`	number	Longitude of the location
`status`	string	`"success"`
`quiet_score`	integer	The calculated Quiet Score™ (0-100)
`listing_id`	string	Unique identifier for the created listing
`analyzed_at`	string	ISO 8601 timestamp when this location was processed

Failed Location

Field	Type	Description
`lat`	number	Latitude of the location
`lng`	number	Longitude of the location
`status`	string	`"failed"`
`error`	string	Error message explaining why this location failed
`analyzed_at`	string	ISO 8601 timestamp when this location was processed

Possible Error Messages

Error	Description
`Failed to calculate quietness score`	Unable to calculate the Quiet Score™ for this location
`Listing limit reached`	Your plan’s listing limit has been reached

Status Values

Status	Description
`QUEUED`	Session is queued and waiting to be processed
`PROCESSING`	Session is currently being processed
`COMPLETED`	All locations have been processed
`FAILED`	Session processing failed

Notes

Poll this endpoint periodically to check the status of your session (recommended: every 5-10 seconds)
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
The results array grows as locations are processed - you can see partial results while the session is still PROCESSING
Use the listing_id from successful results to query individual listings or delete them later

Create Session Get Account Usage

​Overview

​Authorization

​Query Parameters

​Response Fields

​Results Array

​Successful Location

​Failed Location

​Possible Error Messages

​Status Values

​Notes

Overview

Authorization

Query Parameters

Response Fields

Results Array

Successful Location

Failed Location

Possible Error Messages

Status Values

Notes