דלג לתוכן הראשי
GET
/
scenarios
/
runs
curl -g "https://YOUR_PROJECT.texterchat.com/server/api/v2/scenarios/runs?scenarioId=6970b3c1d2e3f40123456789&sortStarted=desc&limit=20" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "total": 123,
  "runs": [
    {
      "_id": "<string>",
      "scenarioId": "<string>",
      "version": 123,
      "success": true,
      "started": 123,
      "executionTime": 123,
      "conditionsResult": true,
      "steps": [
        {}
      ]
    }
  ]
}

הרשאות

​
Authorization
string
header
נדרש

API token generated in Texter: gear icon → Developers → API Tokens. When creating a token, assign it the scopes required by the endpoints you plan to call - each endpoint lists its required scopes.

פרמטרי שאילתה

​
scenarioId
string

Filter runs of a specific scenario (subscription)

​
version
string

Filter by revision version (1-100000)

Pattern: ^[0-9]+$
​
success
enum<string>

Filter by run success

אפשרויות זמינות:
true,
false
​
conditionsResult
enum<string>

Filter by overall conditions result

אפשרויות זמינות:
true,
false
​
sortStarted
enum<string>

Sort by start time

אפשרויות זמינות:
asc,
desc
​
sortExecutionTime
enum<string>

Sort by execution time

אפשרויות זמינות:
asc,
desc
​
limit
string

Maximum results to return (1-10000)

Pattern: ^[0-9]+$
​
skip
string

Results to skip (0-1000000)

Pattern: ^[0-9]+$

תגובה

The matching runs and total count. Field-by-field reference: The Scenario Run object

​
total
number
​
runs
object[]