Skip to content
HALOWERK

Datenwerk

mini survey

Creates 1 to 50 private fragment links for an immutable questionnaire of 1 to 10 required single-choice questions, each with 2 to 10 fixed text options. The agent distributes one link per recipient itself. A transaction accepts one response per link, with a request nonce for safe retry after a lost response. POST survey_id and results_token to results_url for free aggregate counts; POST survey_id and delete_token to delete_url to remove the logical record. Questions and answers are.

POST https://daten.halowerk.com/v1/mini-survey

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
titlestringYesPlain-text questionnaire title.
instructionsstringYesPlain-text instructions; do not request secrets, personal details or contact information.
questionsarrayYes
participantsintegerNoNumber of independent single-response links. No identities are collected or verified.
expires_in_secondsintegerNoSubmission and results-access deadline; retrieve results before expiry.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "title",
    "instructions",
    "questions"
  ],
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160,
      "description": "Plain-text questionnaire title."
    },
    "instructions": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000,
      "description": "Plain-text instructions; do not request secrets, personal details or contact information."
    },
    "questions": {
      "type": "array",
      "minItems": 1,
      "maxItems": 10,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "question",
          "options"
        ],
        "properties": {
          "question": {
            "type": "string",
            "minLength": 1,
            "maxLength": 300
          },
          "options": {
            "type": "array",
            "minItems": 2,
            "maxItems": 10,
            "uniqueItems": true,
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            }
          }
        }
      }
    },
    "participants": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 5,
      "description": "Number of independent single-response links. No identities are collected or verified."
    },
    "expires_in_seconds": {
      "type": "integer",
      "minimum": 60,
      "maximum": 604800,
      "default": 86400,
      "description": "Submission and results-access deadline; retrieve results before expiry."
    }
  }
}

Open original schema

Published input example

{
  "title": "Choose the next documentation improvement",
  "instructions": "Please choose one option for every question. Do not enter names or contact details.",
  "questions": [
    {
      "question": "Which example would help most?",
      "options": [
        "Command line",
        "JavaScript",
        "Python"
      ]
    },
    {
      "question": "Preferred format?",
      "options": [
        "Short guide",
        "Worked example"
      ]
    }
  ],
  "participants": 5
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’