Skip to main content
GET
/
api
/
side-groups
/
progress
Get Progress
curl --request GET \
  --url https://api.example.com/api/side-groups/progress \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-token: <api-key>'
{
  "success": true,
  "progress": {
    "current_required": 2,
    "total_required": 2,
    "current_optional": 1,
    "total_optional": 3,
    "met": true
  },
  "last_updated": "2024-01-01T00:00:00.000Z"
}

Authorizations

​
x-api-key
string
header
required

API key for application authentication (format: leo_xxxxxxxxx)

​
x-user-token
string
header
required

Secure user token (Non-PII format: lm_usr_xxxxx) - PROPOSED: Not yet implemented

Query Parameters

​
sr_id
string<uuid>
required

Service request UUID

Response

Service request progress retrieved successfully

​
success
boolean
Example:

true

​
progress
object
​
last_updated
string<date-time>

Last update timestamp of the service request

Example:

"2024-01-01T00:00:00.000Z"

​
warning
string

Warning message if media count is unavailable

Example:

"Media count unavailable due to S3 connectivity issues"

​
s3_error
boolean

Indicates if there was an S3 connectivity error

Example:

false