API-dokumentation

Niotio REST API. Base URL: /api

Generér autentificerede eksempler

Indsæt dit API-token én gang, så indsætter kopieringsknapperne på eksemplerne nedenfor det for dig. Der sendes ingen kald fra denne side.

Tokenet bliver i din browser og sendes ikke fra denne side.
Endpoint-overblik
Metode Sti Auth Beskrivelse
GET/api/campaignsBearer-tokenHent kampagner
GET/api/campaigns/{id}Bearer-tokenHent kampagne via id
POST/api/campaignsBearer-tokenOpret kampagne
GET/api/metricsBearer-tokenHent samlede nøgletal
GET/api/v1/usage/emailBearer-tokenHent forbrug af undersøgelses-e-mails denne måned
POST/api/responsesRespondent-tokenIndsend svar
Sådan får du et bruger-API-token
  1. Log ind i Niotio.
  2. Gå til Indstillinger.
  3. Under API-tokens indtaster du et navn og klikker på Generer nyt token.
  4. Kopiér token med det samme (det vises kun én gang).
Sådan bruger du API'et

Send token med i Authorization-headeren:

Authorization: Bearer YOUR_API_TOKEN
Hent kampagner
curl -X GET "https://maskinen.stigsen.dk/api/campaigns" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Hent kampagne via id
curl -X GET "https://maskinen.stigsen.dk/api/campaigns/1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Opret kampagne

En kampagne er enten en rigtig kampagne (rigtige respondenter, ingen simulerede data) eller en testkampagne (kun simulering, sender aldrig rigtig mail, indgår ikke i din NPS-score). Angiv det med "campaignType": "REAL" | "TEST" (eller den gamle boolean "test": true). Typen er fast ved oprettelsen; sender du en anden til PUT /api/campaigns/<id>, får du 400.

curl -X POST "https://maskinen.stigsen.dk/api/campaigns" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q1 NPS",
    "description": "First quarter survey",
    "campaignType": "REAL"
  }'
Filtrér kampagner på type
curl -X GET "https://maskinen.stigsen.dk/api/campaigns?test=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Indsend svar (offentligt undersøgelses-token)
curl -X POST "https://maskinen.stigsen.dk/api/responses?token=RESPONDENT_TOKEN&rating=10&comment=Great"
Hent samlede nøgletal
curl -X GET "https://maskinen.stigsen.dk/api/metrics" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Hent forbrug af undersøgelses-e-mails denne måned

Samme tælling som månedskvoten (kalendermåned, Europe/Copenhagen). Ubegrænsede planer: limit og remaining er null. Free: limit 100. Tilføj ?include=campaigns for fordeling på kampagner (kun denne måned, testkampagner tælles ikke med).

curl -X GET "https://maskinen.stigsen.dk/api/v1/usage/email?include=campaigns" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{"plan":"PRO",
 "period":{"start":"2026-10-01","end":"2026-10-31","resetsOn":"2026-11-01","timezone":"Europe/Copenhagen"},
 "emails":{"limit":1000,"used":412,"remaining":588,"percent":41},
 "campaigns":[{"id":12,"name":"Q4 NPS","used":300}]}