Report Subscription - Retrieves subscription history of a subscription

Retun subscription history of a subscription.

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

reportSubscriptionIdstring · uuidOptional

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Responses

200

Success: Subscription history successfully fetched.

text/plainapplication/jsontext/json

Represents the history of a subscription run, including details such as schedule, status, and timestamps.

reportSubscriptionIdstring · uuidOptional

Gets or sets the unique identifier for the report subscription.

runIdstring · uuidOptional

Gets or sets the unique identifier for the run.

schedulestring · nullableOptional

Gets or sets the schedule associated with the subscription run.

isRecipientSpecificbooleanOptional

Gets or sets a value indicating whether the run is recipient specific.

isOnDemandbooleanOptional

Gets or sets a value indicating whether the run was triggered on demand.

timeStampstring · date-timeOptional

Gets or sets the timestamp of the run.

runStatusstring · nullableOptional

Gets or sets the status of the run.

exportIdstring · nullableOptional

Gets or sets the export id.

400

Bad Request: The request could not be processed due to invalid syntax or missing/incorrect parameters.

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

404

Not Found: The specified user does not exist.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

get

/subscriptionHistory

HTTPcURLJavaScriptPython

GET /subscriptionHistory HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "reportSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
    "runId": "123e4567-e89b-12d3-a456-426614174000",
    "schedule": "text",
    "isRecipientSpecific": true,
    "isOnDemand": true,
    "timeStamp": "2026-03-07T23:34:23.099Z",
    "runStatus": "text",
    "exportId": "text"
  }
]