Skip to main content
GET
/
v2.0
/
playbooks
/
{playbookId}
/
runs
/
{playbookRunId}
Returns a Playbook Run
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/playbooks/{playbookId}/runs/{playbookRunId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "status": "successful",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>",
  "stepResults": [
    {
      "status": "failed",
      "text": "Hello, how are you?",
      "data": {},
      "_id": "<string>",
      "asserts": [
        {
          "type": "assertText",
          "status": "failed",
          "params": {},
          "negate": false,
          "actual": {},
          "_id": "<string>"
        }
      ]
    }
  ],
  "flowId": "uuid",
  "localeId": "uuid",
  "entrypoint": "^[a-z0-9]{24}$"
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
playbookId
string
required

The Id of the Playbook

Required string length: 24
​
playbookRunId
string
required

The Id of the Playbook Run

Required string length: 24

Response

Returns Playbook Run object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

​
status
enum<string>

Whether the playbook run was successful or failed

Available options:
successful,
failed
Example:

"successful"

​
_id
string
Required string length: 24
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
​
lastChangedBy
string
Required string length: 24
​
stepResults
object[]
​
flowId
string

Reference Id of the flow

Example:

"uuid"

​
localeId
string

Reference Id of the locale

Example:

"uuid"

​
entrypoint
string

snapshot or project ID

Example:

"^[a-z0-9]{24}$"

⌘I