Sankeys

Draft Sankey

POST
/v0/projects/{idOrSlug}/sankeys/draft

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

Request Body

application/json
  1. body
prompt*string
Lengthlength <= 1000
current*|null
points*array<string>
Itemsitems <= 300

Response Body

Success

application/json
  1. response
name*string
definition*
display*
Example Request
curl -X POST 'https://api.faststats.dev/v0/projects/string/sankeys/draft' \  -H 'Content-Type: application/json' \  -d '{  "prompt": "string",  "current": {    "name": "string",    "definition": {},    "display": {}  },  "points": [    "string"  ]}'
Example Response
{  "name": "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  }}