Gå til hovedinnhold

Skyra API (beta)

Skyra har et API som lar deg hente ut data fra undersøkelsene dine direkte – uten å gå via appen.

Dokumentasjon

📄 API-dokumentasjon finnes her:
api.skyra.no/docs/api/beta.

Betastatus

Dette er et beta-API. Endepunkter og responsformat kan endre seg uten varsel. Etter hvert som vi samler erfaringer og tilbakemeldinger, planlegger vi et V1-API – muligens med et annet endepunktdesign.

Aktivering

API-et kan aktiveres ved forespørsel til Skyra-teamet. Ta kontakt med oss på [email protected], om du ønsker tilgang.

API-nøkler og tilganger

Når du får en API-nøkkel, kan den konfigureres med følgende tilganger:

  • Response text access – Bestemmer om nøkkelen kan lese fritekststsvar, for eksempel fra Input Card.

  • Allowed surveys – Begrenser hvilke undersøkelser nøkkelen har tilgang til. Hvis ingen undersøkelser er valgt, kan nøkkelen lese alle undersøkelser i workspacet.

Hva kan du hente ut?

API-et er delt inn i fem kategorier:

  1. Discovery – Finn ID-er til undersøkelser, kort, segmenter og andre ressurser. Start her for å finne ID-ene du trenger i andre kall. Disse endepunktene returnerer metadata og er ikke for analyse.

  2. Card Reports – Rapportdata per kort, tilsvarende det du ser i rapport-visningen i Skyra-appen. Støtter filtrering på datoperiode, enhet, segment med mer.

  3. Survey Reports – Aggregerte tall for undersøkelser: sammendrag, trender, tag- og trait-fordeling og mer. Disse leser fra forhåndsaggregerte tabeller og støtter kun datofilter.

  4. Task Reports – Aggregerte tall for Top Task-undersøkelser, inkludert workspace-wide leaderboard og trender på tvers av oppgaver.

  5. Raw Data – Rå responser rad for rad, tilsvarende All responses i appen. Støtter paginering og er nyttig for eksport og egen databehandling.

Eksempel: Hent rapport for en undersøkelse

Steg 1 – Finn ID-en til undersøkelsen din:

curl "https://api.skyra.no/beta/surveys" \
-H "Authorization: Bearer <api-key>"

Steg 2 – Hent rapporten:

curl -X POST "https://api.skyra.no/beta/reports/survey/<surveyId>" \
-H "Authorization: Bearer <api-key>" \
-H "Content-Type: application/json" \
-d '{"filters":{"startDate":"2025-01-01T00:00:00Z","endDate":"2025-12-31T23:59:59Z"}}'

Svarte dette på spørsmålet?