Produktly docs
Micro surveys

Create a micro survey

POST
/micro-surveys

Creates the survey as a draft. Pass active: true to publish immediately — the survey must have at least one question and targeting set, otherwise it stays a draft and the response note explains why. The response includes a dashboardUrl for reviewing the survey in the builder.

Authorization

BearerAuth
AuthorizationBearer <token>

Use an API key from the Produktly dashboard → Settings → API keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/micro-surveys" \  -H "Content-Type: application/json" \  -d '{    "name": "Post-checkout survey",    "settings": {      "questions": [        {          "question": "How easy was checkout?",          "type": "rating"        }      ],      "displayTrigger": "time_delay",      "displayDelay": 5    },    "targeting": {      "showOnAllPages": true    },    "active": true  }'
{  "id": 0,  "name": "string",  "active": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "folderId": 0,  "themeId": 0,  "settings": {    "property1": null,    "property2": null  },  "rules": [    {      "property1": null,      "property2": null    }  ],  "ruleLogicalOperator": "string",  "dashboardUrl": "string",  "note": "string"}