Skip to main content
GET
/
beta
/
cards
/
{cardId}
/
context
Get card context
curl --request GET \
  --url https://api.vistaly.com/beta/cards/{cardId}/context \
  --header 'Authorization: Bearer <token>'
{
  "context": [
    {
      "cardId": "<string>",
      "cardTitle": "<string>",
      "cardDetails": "<string>",
      "cardType": "assumption",
      "cardStatus": "<string>",
      "cardUrl": "<string>",
      "level": 123,
      "children": [
        "<string>"
      ],
      "organizationId": "<string>",
      "workspaceId": "<string>",
      "metricCurrent": 123,
      "metricTarget": 123,
      "metricUnit": "<string>",
      "insights": [
        {
          "insightId": "<string>",
          "insightUrl": "<string>",
          "textPreview": "<string>",
          "customerInteractionId": "<string>",
          "interviewUrl": "<string>",
          "customerOrganization": {
            "id": "<string>",
            "name": "<string>"
          }
        }
      ],
      "comments": [
        {
          "commentId": "<string>",
          "commentUrl": "<string>",
          "text": "<string>",
          "author": {
            "userId": "<string>",
            "name": "<string>"
          },
          "createdAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "metadata": {
    "direction": "ancestors",
    "cardCount": 123,
    "maxLevel": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cardId
string
required

The unique identifier for the card

Query Parameters

direction
enum<string>
default:descendants

Direction to traverse the card hierarchy

Available options:
ancestors,
descendants,
both
maxLevels
integer
default:4

Maximum depth for traversal (1-10)

Required range: 1 <= x <= 10
includeTargetCard
boolean
default:true

Include the target card in results

includeComments
boolean
default:false

Include comments for each card

includeInsights
boolean
default:true

Include insights for each card

includeDescriptions
boolean
default:false

Include card descriptions (details)

Response

Card context retrieved successfully

Response containing card context with hierarchical data

context
object[]
required

Array of enriched card contexts

metadata
object
required

Metadata about the card context response