For mere detaljeret API-dokumentation, besøg venligst vores Silktide API-dokumentationsside.
Denne side forklarer, hvordan du bruger vores API til at hente overordnede statistikker om de websites, der er i din Silktide-konto.
Den almindelige brugssag for vores API er at udtrække data til brug i din organisations interne rapporteringsværktøjer, såsom Power BI eller Tableau.
Alle forespørgsler til vores API skal være autentificerede ved hjælp af en Silktide-konto API-nøgle. Vores API er RESTful og kommunikerer ved hjælp af JSON.
For at få din API-nøgle, kontakt venligst din Account Manager for at få denne.
Autentificering af en forespørgsel
Send din API-nøgle som en forespørgselsparameter (?apiKey=DIN_NØGLE) med hver forespørgsel.
Hvis din API-nøgle er ugyldig, eller du ikke har adgang til den ressource, du anmoder om, vil du modtage følgende svar:
{ "error": { "type": "Exception", "message": "Ugyldig API-nøgle", "properties": { "requiredPermission": null } }, "type": "AccessDenied"}API-endpoint
Metode: GET
Endpoint: api.{regionId}.silktide.com/v1/websites/stats
{regionId} er den region, din konto er gemt i.
us for USA.
eu for resten af verden.
Eksempel på API-forespørgsel
curl https://api.us.silktide.com/v1/websites/stats?apiKey=DIN_NØGLE
Eksempel på API-svar
{ "websites": { "2": { "name": "Mit Hovedwebsite", "homeUrl": "https://www.example.com/", "websiteId": 2, "stats": { "wcag-20-a.score": { "label": "WCAG 2.0 A score", "value": 64.510262 }, "wcag-20-aa.score": { "label": "WCAG 2.0 AA score", "value": 59.042248 }, "wcag-20-aaa.score": { "label": "WCAG 2.0 AAA score", "value": 58.114101 }, "wcag-20.score": { "label": "Tilgængelighed (WCAG 2.0) score", "value": 61.363632 }, "wcag-21-a.score": { "label": "WCAG 2.1 A score", "value": 64.510262 }, // ... og mange flere statistikker }, "sections": { "3": { "name": "Vine udvalg", "homeUrl": "https://www.example.com/wines", "sectionId": 3, "stats": { "wcag-20-a.score": { "label": "WCAG 2.0 A score", "value": 60.510262 }, "wcag-20-aa.score": { "label": "WCAG 2.0 AA score", "value": 54.042248 }, "wcag-20-aaa.score": { "label": "WCAG 2.0 AAA score", "value": 52.114101 }, "wcag-20.score": { "label": "Tilgængelighed (WCAG 2.0) score", "value": 63.363632 }, "wcag-21-a.score": { "label": "WCAG 2.1 A score", "value": 68.510262 }, // ... og mange flere statistikker } } } } }}Svarfelter
Hvert resultat inden for nøglen af websites vil være nøgleopdelt efter Website ID og indeholde nøgleinformation om websitet.
Dette inkluderer stats-objektet, som vil returnere de vigtigste statistikker for det pågældende website på det nuværende tidspunkt.
sections-objektet inde i et website er nøgleopdelt efter Section ID og vil indeholde nøgleinformation om sektionen og et andet stats-objekt for netop den sektion.
Hver statistik indeholder en kort beskrivelse af, hvad den bruges til.