API: Ordlista
Viktiga termer som används i Insight API och dokumentation.
- Anonymitet (AnonOk)
Insight skyddar enskilda respondenters integritet. När en grupp har för få respondenter för att garantera anonymitet döljs resultaten. Fältet "anonOk" anger om resultaten är synliga (true) or återhållna (false).
- Användare
En person i din organisation som kan delta i undersökningar. Användare har ett namn, en e-postadress, ett valfritt externalId för mappning via HR-system, grupptillhörighet, och en uppsättning attribut. Användare kan ha status Active, Deactivated, or Deleted.
- API Token
En autentiseringsuppgift som ger åtkomst till Insight API. Tokens skapas av administratörer i Insight och har specifika behörigheter som styr vilka slutpunkter de har åtkomst till (t.ex. organisationsdata, enkätdata, resultat).
- Attribut
En konfigurerbar, organisationsspecifik egenskap kopplad till användare (t.ex. roll, plats, anställningstyp). Attributnamn kan hämtas på olika språk via languageCode.
- Behörigheter/rättigheter
API tokens ha detaljerade behörigheter:
- Organisation – åtkomst till gruppdata
- Undersökning – åtkomst till undersökningslistor
- Resultat – åtkomst till undersökningsresultat, index och frågor
- Organisation.EditGroup.CreateUser — krävs för att skapa användare via
POST /api/public/users - Organisation.EditUser.Update — krävs för att uppdatera användare via
PUT /api/public/users - Organisation.EditUser.Delete — krävs för att "soft-delete" användare via
DELETE /api/public/users
- CX (kundundersökning)
En företagstyp i Insight-plattformen som fokuserar på kundfeedback snarare än medarbetarengagemang. CX-företag har tillgång till individuella svarsdata via GET /api/public/surveys/{id}/responses; företag som inte är CX ser endast aggregerade resultat.
- Externt ID
En valfri identifierare som du tilldelar grupper för att matcha dem med enheter i externa system (t.ex. team-ID:n i ditt HR-system). Användbar för automatiserad synkronisering.
- Fråga
En enskild fråga i en undersökning. Frågorna kan vara:
- Standard — tillhandahålls av Insight, används i alla organisationer
- Företagsspecifika/kundunika — anpassade frågor som lagts till av er organisation
Frågorna visas på det språk du anger via languageCode parametern.
- Grupp
En organisatorisk enhet i Insight – vanligtvis representerande ett team, en avdelning, ett kontor eller annan strukturell enhet. Grupper tillhör en kategori (t.ex. "team", "avdelning") och kan ha ett externt ID för mappning till andra system.
- Index
Ett tema för engagemang på hög nivå som aggregerar flera frågor till en enda poäng. Exempel inkluderar ledarskap, självständighet, meningsfullt arbete och laganda. Varje organisation använder de index som är relevanta för dem.
- Kategori
En klassificering för grupper. Vanliga kategorier inkluderar "team" och "summering". Kategorier hjälper till att organisera grupper i meningsfulla lager i din organisationshierarki.
- Language Code/Språkkod
En tvåbokstavskod enligt ISO 639-1-standarden, som används för att begära lokaliserat innehåll.
Exempel: en (English/Engelska) sv (Swedish/Svenska) da (Danish/Danska) no (Norwegian/Norska) fi (Finnish/Finska)
- Resultat
Aggregerade enkätsvar. Resultaten är tillgängliga per grupp, uppdelade efter index och frågor. Resultaten är endast tillgängliga för enkäter som är avslutade och beräknade.
- Tonalitet
En sentimentklassificering som tillämpas på fritextsvar i CX-undersökningar. Varje fritextsvar kan ha en övergripande tonalitet (Negative, Neutral, Positive, eller Unknown) och tonaliteter per kategori. Tillgängliga fritextkategorier kan hämtas via GET /api/public/freetext-categories.
- Undersökning
En enkät som skickas till anställda för att mäta engagemang. Undersökningar kan vara:
- Engångsförfrågan — skickas en gång
- Återkommande — upprepas automatiskt enligt ett schema
Undersökningar går igenom följande statusar: schemalagd, pågående (öppen för svar) och avslutad (stängd och beräknad).