Hoppa till innehåll
Svenska
Kontakta oss
  • Det finns inga förslag eftersom sökfältet är tomt.

API: Kom igång

Den här artikeln guidar dig kring att göra ditt första Insight API-anrop.

Steg 1: Hämta din API-token

För att komma igång med API:et, kontakta din Brilliant-representant. De kommer att konfigurera en API-token för din organisation med lämpliga behörigheter.

När du har fått din token, förvara den säkert – den ger åtkomst till din organisations data. Dela den inte i koddatabaser, e-postmeddelanden eller chattmeddelanden.

Steg 2: Autentisera

Alla API-förfrågningar kräver en JWT-bärartoken i Authorization rubriken:

Authorization: Bearer YOUR_API_TOKEN

 

Steg 3: Genomför ditt första anrop

Ett bra första anrop är att lista dina grupper för att kontrollera att allt fungerar.

Begäran:

GET /api/public/groups
Authorization: Bearer YOUR_API_TOKEN

Respons:

{
  "groups": [
    {
      "groupId": 1,
      "name": "Engineering",
      "externalId": "ENG-001",
      "categoryKey": "team",
      "isDeleted": false
    },
    {
      "groupId": 2,
      "name": "Marketing",
      "externalId": "MKT-001",
      "categoryKey": "team",
      "isDeleted": false
    }
  ]
}

 

Steg 4: Utforska vidare

När autentiseringen är klar; här är ett typiskt arbetsflöde för att hämta undersökningsresultat:

1. GET /api/public/surveys          → Find the survey you're interested in
2. GET /api/public/indexes?languageCode=en   → Get available indexes
3. GET /api/public/groups           → Get your organization's groups
4. GET /api/public/surveys/{id}/results      → Pull the results

För företag som fokuserar på kundupplevelse (CX) kan ni även hämta individuella respondentdata, vilket är användbart för att analysera fritextsvar och tonalitet:

1. GET /api/public/surveys                       → Find the survey
2. GET /api/public/freetext-categories           → Get categories used for free-text tonality classification
3. GET /api/public/surveys/{id}/responses        → Pull individual responses (CX surveys only)

För synkronisering gällande HR-system låter slutpunkterna för användarhantering dig hålla Insight i linje med din sanningskälla:

1. GET /api/public/users                 → Read current users
2. POST /api/public/users                → Create new joiners (bulk, max 100/batch)
3. PUT /api/public/users                 → Update changed users (bulk, max 100/batch)
4. DELETE /api/public/users              → Soft-delete leavers (bulk, max 100/batch)

 

Vanliga mönster

Filtrering efter gruppkategori

Grupper är organiserade i kategorier (t.ex. "team", "avdelning"). Du kan filtrera:

GET /api/public/groups?categoryKey=team


Lokaliserat innehåll

Index och frågor stöder flera språk. Skicka en ISO 639-1-språkkod:

GET /api/public/indexes?languageCode=sv
GET /api/public/questions?languageCode=en


Filtrering av undersökningsresultat

När du hämtar resultat kan du begränsa efter grupp, index eller fråga:

GET /api/public/surveys/42/results?groupId=1&indexId=5

 

Filtrering av individuella svar utifrån datum (CX-undersökningar)

När du hämtar individuella svar för en kundundersökning kan du begränsa tidsfönstret:

GET /api/public/surveys/42/responses?submittedAfter=2026-01-01&submittedBefore=2026-04-01

Filtrering av användare utifrån status

Användarlistan visar som standard aktiva och inaktiverade användare. För att inkludera borttagna användare eller filtrera till en enda status, ange status:

GET /api/public/users?status=Active

 


Felhantering

Statuskod Betydelse
200 OK Begäran lyckades
204 No Content Lyckades utan brödtext (t.ex. massradering)
400 Bad Request Ogiltiga parametrar (t.ex. okänd språkkod eller CX-endpoint som anropas från ett företag som inte är CX)
401 Unauthorized Saknat eller ogiltigt token
403 Forbidden Token har inte den behörighet som krävs

 

Nästa steg