Sankeys

Get Sankey

GET
/v0/projects/{idOrSlug}/sankeys/{sankeyId}

Authorization

apiKeyAuth
headerx-api-key<token>

FastStats API key. Pass it in the x-api-key header or as a Bearer token in the Authorization header.

Path Parameters

idOrSlug*string
sankeyId*string

Response Body

SankeyRecord

application/json
  1. response
id*string
projectId*string
name*string
description*string|null
definition*
display*
dashboardId*string|null
folderId*string|null
notebookId?string|null|null
position*|null
createdAt*string
updatedAt*string
Example Request
curl -X GET 'https://api.faststats.dev/v0/projects/string/sankeys/string'
Example Response
{  "id": "string",  "projectId": "string",  "name": "string",  "description": "string",  "definition": {    "days": 1,    "stepCount": 2,    "nodesPerStep": 2,    "minSessions": 1,    "pathType": "all",    "walkBy": "session",    "pageLabel": "path",    "groupUrls": true,    "collapseRepeats": true,    "startPoint": "string",    "startOccurrence": "first",    "endPoint": "string",    "endOccurrence": "first",    "include": [      "string"    ],    "exclude": [      "string"    ],    "rules": [      {        "pattern": "string",        "replacement": "string"      }    ],    "filters": [      {        "field": "step",        "operator": "is",        "values": [          "string"        ]      }    ],    "goal": "string",    "maxGapMinutes": 0,    "hideSingleStep": true,    "eventProperty": "string",    "breakdown": "country",    "compare": true  },  "display": {    "view": "flow",    "values": "count",    "showDropOffs": true,    "showOther": true  },  "dashboardId": "string",  "folderId": "string",  "notebookId": "string",  "position": {    "x": 0,    "y": 0,    "w": 0,    "h": 0  },  "createdAt": "string",  "updatedAt": "string"}