Webperfs API

Mer information och dokumentation kommer löpande. Om inget annat anges är det JSON-format på svaren. Vill du se OpenAPI/Swagger-dokumentationen så finns den här!

1. Öppna data

De data som Webperf släpper som öppna data går under licensen CC BY-SA 4.0. Det innebär att du behöver göra ett korrekt erkännande (att datakällan är Webperf) och om du delar datakällan vidare, eller bearbetar den, ska den behålla samma licens.

1.1 URL till kommuners och regioners webbplatser

De URL:ar du får ur denna API-endpoint är till startsidan för kommuners och regioners webbplatser så som det sparats hos Webperf.se
Notera att Visby kommun i denna lista ersatts av Region Gotland.

Data i svaret är följande:

• api_version är ett versionsnummer (decimal) som förklarar vilken version av API:t du nått. Bra som referens ifall du sparar ner resultatet.
• result_count antal unika webbplatser i listan med data (heltal som textsträng).
• timestamp datum och klockslag (timestamp) på serversidan när resultatet senast uppdaterades.
• data lista med webbplatser, som innehåller följande data:
  • category textsträng som antingen är Municipality, det vill säga en kommun, eller Region om det är en region.
  • sameAs är en URI (sträng) med hänvisning till samma organisation på Wikidata.
  • title textsträng med namnet på organisationen.
  • uri textsträng med referens till organisationen på Webperf. Work-in-progress. Kommer URL:ar till Webperf-internt innehåll på sikt.
  • url textsträng för organisationens adress till startsida på webbplats.

Poängen med URI:er till Wikidata? Länkade data!

"Länkade data är en metod för att publicera strukturerad data på ett sätt som gör det möjligt att följa kopplingar mellan informationsobjekt över flera källor. Länkade data bygger på webbstandarder som HTTP och URI:er men istället för att använda dem för att presentera information för människor är syftet att göra data läsbart för maskiner. Målet är att möjliggöra för vitt skilda aktörer att beskriva sin information på ett enhetligt sätt och därmed förenkla återanvändning och interoperabilitet."

Du kan alltså relatera information hos Webperf med Wikidata, vilket gör att du kan hämta dels ännu mer data men också koppla till olika Wikipedia-artiklar du kan vilja bearbeta. Detta gör datakällan maskinläsbar och kan bearbetas automatiserat i din egen tillämpning.

Det kan vara bra om du vill automatisera hämtningen av kommuners namn på andra språk, vilket landskap de ingår i, storlek på befolkning, deras officiell mejladress, bilder från Wikimedia och allt annat som erbjuds av Wikidata. Se exempelvis Wikidatas URI för Åmåls kommun.

Kodexempel för dig som vill komma igång med Webperfs öppna data

På Webperfs Github-konto finns kodexempel du kan återanvända eller ta inspiration ifrån.

• 01 - Kodexempel för api.webperf.se hämtar kommuner och regioner från Webperf, ansluter till respektive webbplats, kollar in sidtitlarna, hämtar befolkningsdata från Wikidata.

1.2 Beständig URI (för kommuner och regioner)

En URI är en identifierare inom (länkade) öppna data-världen. Den är tänkt att vara bestående och en unik referens som du kan stöta på i datamängder från Webperf. Det står även utomstående parter fritt att använda dessa URI:er.
Du hittar URI:er i respektive listning och de går också att slå upp. En URI för Webperf följer nedan syntax och ger den publika information som finns att lämna ut.

Har du Premium? Då kan du få ut din egen data och de övergripande betygen bara du anger en API-nyckel. Se mer om URI:er för Premium.

Exempelvis följande för Västra Götalandsregionen:

Data i svaret är följande:

• api_version är ett versionsnummer (decimal) som förklarar vilken version av API:t du nått. Bra som referens ifall du sparar ner resultatet.
• timestamp datum och klockslag (timestamp) på serversidan när resultatet senast uppdaterades.
• data listar information om webbplatsen:
  • category textsträng som antingen är Municipality, det vill säga en kommun, eller Region om det är en region.
  • sameAs är en URI (sträng) med hänvisning till organisationen på Wikidata.
  • title textsträng med namnet på organisationen.
  • uri textsträng med referens till organisationen på Webperf. Work-in-progress. Kommer URL:ar till Webperf-internt innehåll på sikt.
  • url textsträng för organisationens adress till startsida på webbplats.

1.3 Typer av test

I flera av API:ts svar dyker det upp ett fält type_of_test – ett heltal som identifierar vilken sorts test som körts. Denna endpoint är en öppen katalog över samtliga testtyper i Webperf Core, med deras id-nummer och namn. Du behöver alltså ingen API-nyckel. Datakällan är Webperf Core och släpps som öppna data.

Observera att namnen på de testtyper som är aktiva i nuvarande Webperf Core är hämtade ordagrant ur Webperf Cores egna språkfiler. Beskrivningar, samt namn för historiska (inaktiva) tester på danska, norska, finska och isländska, är maskinöversatta från svenska/engelska och bör granskas innan du litar helt på dem.

Hämta hela listan:

Eller en enskild testtyp via dess id-nummer:

Exempelvis följande för prestandatestet (Sitespeed.io):

Två valfria query-parametrar finns:

• lang plattar ut svaret till ett enda språk. Tillåtna värden är sv, en, da, no, fi och is. Utelämnar du den får du samtliga språk samlade under noden translations. Anger du ett språk som inte stöds får du statuskod 400.
• active med värdet 1, true eller yes ger dig enbart de testtyper som ingår i nuvarande testsvit. Endast för listan.

Exempel med svenska namn och bara aktiva tester:

Data i svaret är följande:

• count heltal om hur många testtyper som finns i listan med data.
• meta metadata om datakällan: language visar vilket språk svaret gäller (eller all om du inte valt något), catalogue_size är antalet testtyper som någonsin funnits (pensionerade inräknade, så att gamla type_of_test-värden går att slå upp) och active_count antalet i nuvarande testsvit. count ovan är vad just ditt anrop fick.
• tests lista med testtyper (eller test med ett enda objekt när du hämtar via id-nummer), som innehåller följande data:
  • id heltal som identifierar testtypen. Detta är samma nummer som du ser i type_of_test i andra API-svar.
  • active boolean som anger om testtypen ingår i nuvarande Webperf Core-testsvit.
  • url_with_details textsträng med en URL till mer information om testet på Webperf.se (kan vara tom).
  • name, description och long_description textsträngar med namn och beskrivningar. Dessa ligger direkt på objektet om du angett lang.
  • translations finns istället om du inte angett lang, och har en nod per språk (sv, en, da, no, fi, is) med respektive name, description och long_description.

Svaret levereras med långa cache-headers och en ETag, så ett villkorat anrop med If-None-Match kan ge statuskod 304 (Not Modified) och spara bandbredd.

1.4 Fler öppna endpoints

Utöver de ovan finns några nyare öppna endpoints. De ger samma kommuner och regioner som 1.1, men i ett modernare format med betygen inkluderade, paginering och sökning. Alla svarar med JSON och kräver ingen nyckel.

• GET https://api.webperf.se/v1/public/municipalities – alla kommuner med aktuella betyg (ratings med overall, accessibility, performance, standards och security som decimaltal, eller null om betyg saknas).
• GET https://api.webperf.se/v1/public/regions – samma sak för regioner.
• GET https://api.webperf.se/v1/public/stats – antal webbplatser och genomsnittsbetyg för hela offentlig sektor.
• GET https://api.webperf.se/v1/sites?query=text&category=2|3&limit=25&offset=0 – sök bland kommuner (kategori 2) och regioner (kategori 3) på namn eller adress, med pagination i svaret. Högst 100 per sida.
• GET https://api.webperf.se/v1/sites/nummer – en enskild kommun eller region med betyg, datum och antal aktuella tester. Andra webbplatser svarar 403.
• GET https://api.webperf.se/datasets/dcat – datamängderna beskrivna som DCAT-AP (RDF/XML), för Sveriges dataportal.
• GET https://api.webperf.se/health och GET https://api.webperf.se/info – driftstatus respektive en kort beskrivning av API:t.

2. Webperfs premium API

Snabblänkar till premiums endpoints:

• 2.1 Hämta era senaste betyg
• 2.2 Historiska betyg
• 2.3 Testa om startsida
• 2.4 Starta privata tester
• 2.5 Hämta lista med dina privata tester
• 2.6 Hämta testresultat för ett av dina privata tester
• 2.7 Din egen URI ger dig dina senaste övergripande betyg
• 2.8 Få en texts läsbarhetsindex (LIX)
• 2.9 Kategoriernas genomsnitts­betyg
• 2.10 Trigga en Premium Audit
• 2.11 Hämta upp dina Premium Audits eller granskningar
• 2.12 Kvarvarande krediter i din kvot

Enbart för dig med Webperf Cloud på nivån Standard eller Byrå (Agency). Du behöver via ditt konto hämta ut din API-nyckel för att komma igång. Om du inte har din API-nyckel ännu loggar du in på premium.webperf.se och klickar på API-nyckel i menyn för att skapa en.
Läs mer om Webperfs olika konton »

Bra att veta om siffror. De äldre endpointerna (de under /0.1/ och utan prefix) levererar alla tal som textsträngar, till exempel "rating": "4.92" och "result_count": "17". Det är så de alltid har sett ut och ändras inte, för att inte knäcka befintliga integrationer. Undantaget är /quota/ och /whoami/ som ger riktiga heltal. Betyg som saknas skrivs som "-1".

Begränsningar. Varje endpoint har en egen gräns per minut. Svaret bär rubrikerna X-RateLimit-Limit, X-RateLimit-Remaining och Retry-After, och överskrider du gränsen får du statuskod 429.

Premiums API:er versionshanteras för att du ska kunna lita på att dina integrationer inte plötsligt går sönder. Respektive version stöds som minst i 6 månader och det kan komma att bli längre när API:t släpps i nyare versioner framgent.
Dock så måste du inte välja en version i dina anrop, men om du gör det så är det ett mellanled med ett decimaltal i nedan API-endpoints. Om du inte väljer en versionshanterad endpoint får du alltid den senaste versionen.

Om du inte har premium men vill provköra kan du testa det demokonto som finns för Webperf.se som sajt. Då är det API-nyckel 989089bfe899d6992ff320a97 och webbplatsens id-nummer 3843 du använder.

Söker du kodexempel för att jobba med premium-API?

Det finns kodexempel i Python på nedan länk. Det körs i Jupyter Notebook, vilket också är kompatibelt med Google Colab som miljö om du föredrar det.
Med kodexemplet kan du interagera med premium-API:t genom att fråga vilket id-nummer din webbplats har, hämta de senaste resultaten, historiska genomsnittsbetyg samt skapa en graf över genomsnittsbetygen över tid.

Detta är just kodexempel. För att ge inspiration om vad man kan göra för att komma igång med premium-API:t. Det finns säkert andra automatiseringar och integrationer du kommer att tänka på.

• 02 - Kodexempel för premium-API (Github, uppdaterad 2023-07-24)

2.1 Hämta era senaste betyg

Här får du i JSON-format ut samma tester som du kan se på Webperf.se som testresultat.

Inledningsvis vet du kanske inte om vilket id-nummer din webbplats har. Då kan du ställa nedan API-fråga tillsammans med din API-nyckel så kommer du få reda på vilka id-nummer du har behörighet till. Detta framgår också Info-sidan om du loggar in på premium.

Svaret har en lista sites där varje webbplats har site-ID (id-numret, som textsträng), title och website (namn och adress), uri (din URI enligt 2.7) samt endpoint-current-stats och endpoint-historic-stats med färdiga adresser till 2.1 och 2.2. Saknas nyckeln, eller är den ogiltig, svarar just den här listningen med statuskod 400; endpointerna per webbplats svarar 401.

Vill du bara kontrollera att nyckeln fungerar, till exempel i ett CI-jobb, finns ett billigare anrop som inte listar några webbplatser och aldrig innehåller nyckeln själv i svaret:

Svaret innehåller user_id, display_name, role (user, agency_admin eller super_admin), site_count (antal webbplatser nyckeln når) och unrestricted (true för superadmin). Saknad eller ogiltig nyckel ger 401.

När du vet om webbplatsens id-nummer så är din API-endpoint följande för att få ut statistik:

Två valfria query-parametrar finns:

• type_of_test begränsar svaret till vissa tester, kommaseparerat, till exempel ?type_of_test=10,15. Id-numren finns i 1.3 Typer av test. Ogiltigt värde ger statuskod 400.
• include_raw_data med värdet false utelämnar fältet json_check_data, som kan vara hundratals kB per test. Standard är att det är med.

Det kan se ut så här om du använder Webperf.se's demokonto:

Data i svaret är följande:

• api_version är ett versionsnummer (decimal) som förklarar vilken version av API:t du nått. Bra som referens ifall du sparar ner resultatet.
• uri textsträng med referens till vilken webbplats på Webperf testresultaten tillhör.
• result_count antal unika tester i listan med data (heltal som textsträng).
• timestamp datum och klockslag (timestamp) på serversidan när resultatet senast uppdaterades.
• data listar de senaste testresultaten:
  • type_of_test identifierar typ av test som utförts (heltal som textsträng, till exempel "10").
  • rating betyget för det aktuella testet (decimaltal som textsträng, till exempel "4.92"; "-1" om betyg saknas).
  • test_date tidstämpel på serversidan för när testet genomfördes.
  • check_report textsträng med det huvudsakliga testresultatet, i läsbar form.
  • check_report_a11y textsträng med testresultatet som gäller tillgänglighet, i läsbar form.
  • check_report_perf textsträng med testresultatet inom webbprestanda, i läsbar form.
  • check_report_sec textsträng med testresultatet för informationssäkerhet, i läsbar form.
  • check_report_stand textsträng med testresultatet när det gäller webbstandarder, i läsbar form.
  • json_check_data JSON-formaterad textsträng med testresultatet. Används i ett fåtal testtyper. Kan vara mycket stor; se include_raw_data ovan.

2.2 Historiska betyg

Webperf har samlat in testresultat i många år för vissa webbplatser. Exempelvis månatligen för alla kommuner sedan sommaren 2018. Alla betyg ingår i en sorts "kategoribetyg" vilket är det du ser redovisas i de återkommande månadsrapporterna på Webperf.se, men det kan vara jobbigt att sammanställa sina egna data ur dessa rapporter. Därför finns den här API-endpointen.

Det kan se ut så här om du använder Webperf.se's demokonto:

Data i svaret är följande:

• api_version är ett versionsnummer (decimal) som förklarar vilken version av API:t du nått. Bra som referens ifall du sparar ner resultatet.
• uri textsträng med referens till vilken webbplats på Webperf testresultaten tillhör.
• result_count antal unika månadsbetyg i listan med data (heltal som textsträng). Inte att förväxla med antal månader. En och samma månad kan ha en handfull olika betyg i ditt resultat. Se type_of_score nedan.
• timestamp datum och klockslag (timestamp) på serversidan när resultatet senast uppdaterades.
• data listar de samtliga testresultats genomsnittsbetyg:
  • score genomsnittsbetyget för aktuell månad och de tester som ingår i den typen av test (decimaltal som textsträng). Se type_of_score.
  • timeperiod datumangivelse i format yyyy-mm och är inom den period testerna genomfördes.
  • type_of_score textsträng som identifierar vilken typ av tester som räknats samman till ett genomsnittsbetyg för månaden. Alternativen är ganska självförklarande; kat-total totalbetyg för samtliga tester, kat-infosec för informationssäkerhet/integritet, kat-a11y för tillgänglighet, kat-perf för allt inom webbprestanda och kat-webstandard för följsamhet till webbstandarder.

2.3 Testa om startsida

Vill du manuellt köra om testerna av din webbplats för att Webperf.se ska ta en ny titt? Testet gäller startsidan av din webbplats och resultatet kommer att publiceras på Webperf.se när testet är klart, samt att du via API:t kan nå de nya testerna via 2.1 Hämta era senaste betyg.

Du har ett begränsat antal krediter i en rullande 30-dagarsperiod. Varje test kostar 1 kredit. Ryms inte hela beställningen i det du har kvar stoppas den med statuskod 400 – 2.12 Kvarvarande krediter i din kvot säger vad du har kvar innan du beställer.

Numret du anger är webbplatsens id-nummer. Om du inte känner till din webbplats id-nummer kör du API-frågan under 2.1 Hämta era senaste betyg så får du den i svaret.

Utan testnums köas samtliga aktiva tester, 1 kredit per test. Tillåtna id-nummer är de som är aktiva i 1.3 Typer av test (/v1/tests?active=true). Okända eller inaktiva id-nummer ignoreras tyst; återstår inget giltigt id svarar API:t 400 med No valid test numbers provided.

Det kan se ut så här om du använder Webperf.se's demokonto:

Svaret på din POST är statuskod 200 om det gick bra och {"message": "Website with site-id 3843 will be retested in a couple of minutes"}. Felfall: 400 om site-id eller api-key saknas eller är ogiltig, 403 om nyckeln inte når webbplatsen, 404 om webbplatsen inte finns, 400 med Quota exceeded om krediterna inte räcker, och 500 om något gick fel i serverns ände.

2.4 Starta privata tester

Det går att testa upp till 10 valfria undersidor per anrop till API:t. Antalet sidor du kan testa styrs av vilken nivå av premium din webbplats har. Ifall du har en av de större premium-varianterna har du utrymme att göra flera API-postningar i följd och sedan invänta att testresultaten kommer in under de 15-30 minuter det brukar kunna ta.
Se 2.5 Hämta lista med dina privata tester för hur du via API:t kommer över de API-anrop du gör för att nå dessa privata tester.

Du har ett begränsat antal krediter i en rullande 30-dagarsperiod. Varje testad sida kostar 15 krediter – samma pris som i webbgränssnittet på webperf.cloud. Ryms inte hela beställningen i det du har kvar stoppas den med statuskod 400 – 2.12 Kvarvarande krediter i din kvot säger vad du har kvar innan du beställer.

Kroppen skickas som form-data (application/x-www-form-urlencoded eller multipart/form-data), inte som JSON. Flera adresser separeras med kommatecken följt av mellanslag. Alla adresser måste ligga på samma domän som webbplatsen, annars svarar API:t 400.

Det kan se ut så här om du använder Webperf.se's demokonto:

Svaret på din POST är statuskod 200 om det gick bra, med antalet skapade tester och en adress per test där resultatet sedan går att hämta enligt 2.6:

{
    "message": "Created 2 single tests for site-id 3843",
    "endpoints": {
        "7291": "https://api.webperf.se/private_stats/3843/7291",
        "7292": "https://api.webperf.se/private_stats/3843/7292"
    }
}

Statuskod 400 betyder att något saknas eller inte ryms: ingen adress angiven, en adress utanför webbplatsens domän, eller att krediterna inte räcker (då börjar meddelandet med Quota exceeded och anger hur många som behövs och finns kvar i den rullande 30-dagarsperioden).

2.5 Hämta lista med dina privata tester

Dessa kallas privata tester eftersom de inte är åtkomliga öppet på Webperf.se eller andra användare av API:t än de med samma behörighet som du.

Med nedan API-svar får du ut URI:er för att hämta ut samtliga testresultat för en privat testad URL. Denna API-URI kräver att du anger din API-nyckel för att få ut svaret, se 2.6 Hämta testresultat för ett av dina privata tester nedan.

Det kan se ut så här om du använder Webperf.se's demokonto:

Data i svaret är följande:

• api_version är ett versionsnummer (decimal) som förklarar vilken version av API:t du nått. Bra som referens ifall du sparar ner resultatet.
• uri textsträng med referens till vilken webbplats på Webperf testresultaten tillhör.
• result_count antal olika URL:ar som testats (heltal som textsträng).
• timestamp datum och klockslag (timestamp) på serversidan när resultatet senast uppdaterades.
• data listar samtliga URL:ar:
  • date_added ISO-datum (yyyy-mm-dd hh:mm:ss) för när testet begärdes.
  • uri den API-adress som ska anropas för att nå testdetaljer.
  • url är den adress som utvärderats i testerna.

2.6 Hämta testresultat för ett av dina privata tester

Bara de med API-åtkomst till webbplatsen hos Webperf eller inloggade i Premium kan komma åt dessa resultat. De delas inte öppet.

Det kan se ut så här om du använder Webperf.se's demokonto:

Svaret har samma ram som 2.1 Hämta era senaste betyg (api_version, uri, result_count, timestamp och data), men varje post i data har bara fyra fält: test_date, type_of_test, rating och check_report. De uppdelade rapporterna per område och json_check_data finns inte för privata tester. Ett test som ännu inte körts ger en tom data-lista och result_count "0".

2.7 Din egen URI ger dig dina senaste övergripande betyg

Denna endpoint har vissa likheter med 1.2 Beständig URI (för kommuner och regioner), men med skilnaden att det gäller din egen webbplats. Dessutom får du lite mer data eftersom du anger din API-nyckel.

Obs! Notera bindestrecket i api-key i just detta kodexempel. Utan nyckel svarar en webbplats som inte är kommun eller region med 404.

Exempelvis följande för Webperfs demokonto:

Data i svaret är följande:

• api_version är ett versionsnummer (decimal) som förklarar vilken version av API:t du nått. Bra som referens ifall du sparar ner resultatet.
• timestamp datum och klockslag (timestamp) på serversidan när resultatet senast uppdaterades.
• data listar information om webbplatsen:
  • category textsträng som är Municipality för en kommun, Region för en region och Unknown för alla andra webbplatser, till exempel din egen.
  • sameAs är en URI (sträng) med hänvisning till organisationen på Wikidata. Tom för webbplatser utan Wikidata-koppling.
  • title textsträng med namnet på organisationen.
  • uri textsträng med referens till organisationen på Webperf. Work-in-progress. Kommer URL:ar till Webperf-internt innehåll på sikt.
  • url textsträng för organisationens adress till startsida på webbplats.
• scores listar de övergripande betygen för webbsidan, alla som textsträngar ("-1" om betyg saknas):
  • a11y två decimaler, sammanfattar sidans tillgänglighet
  • infosec två decimaler, sammanfattar sidans informationssäkerhet och integritet
  • overall fem decimaler, det övergripande betyget
  • pagespeed två decimaler, sidans hastighet
  • webstandard två decimaler, sidans följsamhet till webbstandard

Svaret är alltså detsamma som i 1.2 Beständig URI, kompletterat med noden scores. Skickar du en nyckel som inte når webbplatsen får du den publika varianten utan scores för kommuner och regioner, och 404 för andra webbplatser.

2.8 Få en texts läsbarhetsindex (LIX)

En text kan vara mer eller mindre lätt att läsa. LIX är ett mått på detta och du med premium-API:t kan enkelt via API:t kolla dina texter. Förr eller senare kommer LIX-beräkning att inkluderas i kvotsystemet med testkrediter.

Endpointen finns bara utan versionsprefix och tar bara POST. Texten skickas som form-data, inte som JSON. Data i svaret ligger under message:

• lix_value heltal med LIX-värdet.
• interpretation textsträng (på svenska) om hur lätt eller svår texten är att läsa.
• stats det som räknades: words, sentences, long_words, avg_sentence_length och long_word_percentage.

Så här kan det se ut:

{
    "message": {
        "lix_value": 52,
        "interpretation": "Svår, normalt värde för officiella texter",
        "stats": {
            "words": 312,
            "sentences": 14,
            "long_words": 94,
            "avg_sentence_length": 22.29,
            "long_word_percentage": 30.13
        }
    }
}

Texter under 50 ord ger statuskod 400 med {"message": "Text must contain at least 50 words"}. Saknas content helt är det 400 med No content provided.

2.9 Kategoriernas genomsnitts­betyg

De kategorier av webbplatser som syns på Webperf.se har genomsnittsbetyg på respektive betygskategori. Dessa kan du med premium-API hämta ut på ett strukturerat sätt.

Data i svaret är följande:

• categories listar samtliga kategorier:
  • cat_id är kategorins id-nummer, som en referens (heltal som textsträng).
  • title namn på kategorin.
  • Betygen nedan är decimaltal som textsträngar, "-1" om betyg saknas.
  • rating_a11y genomsnittligt tillgänglighets­betyg.
  • rating_infosec genomsnittligt betyg för informations­säkerhet.
  • rating_pagespeed genomsnittligt hastighets­betyg.
  • rating_webstandard genomsnittligt betyg för webbstandard.
  • rating_overall genomsnittligt total­betyg.

2.10 Trigga en Premium Audit

För dig med Premium-konto kan du via API:t trigga en Premium Audit. Auditen utgår alltid från webbplatsens startsida och crawlar själv fram sidorna som testas – du kan inte skicka in en egen lista med URL:er.

pages styr hur många sidor som crawlas och testas, och kostar 1 kredit per sida ur din rullande 30-dagarskvot. Du kan beställa högst en audit per timme.

pages går även att skicka som form-data med samma namn, om det passar din klient bättre.

Data i svaret är följande:

{
    "message": "Audit for site-id nnnn will be processed in a couple of hours"
}

Eller, om beställningen inte ryms i dina kvarvarande krediter, statuskod 400 och:

{
    "message": "Quota exceeded. This audit needs 200 credits but only
    40 remain for the current 30-day period."
}

2.11 Hämta upp dina Premium Audits eller granskningar

Du som redan kört en Premium Audit eller vill veta om den du beställde är klar ännu kan använda denna endpoint. Du kan under data få ett tomt resultat ifall inget är färdigt, ett enda resultat som i nedan exempel, eller fler än ett resultat.

Varianter på format är csv för primärt automatiserade tillgänglighets­tester, audit och audit_v2.

Så här funkar resultaten:

• csv – ger dig en kommaseparerad text redo att plockas upp till kalkylark eller för bearbetning med kod. Har inga result_files.
• audit – är som, i nedan exempel, en del metadata om ett testresultat och result_files ger dig en lista med JSON-filer. Innehållet i JSON-filerna är det du skulle finna av Google Lightouse på senare tid.
• audit_v2 – samma sak, men med två filer till: crux_summary.json (Googles CrUX-data) och privacy_summary.json (integritet). Dessutom summaries.zip som innehåller alla sammanfattningarna i ett arkiv – ett anrop i stället för sex.

Svaret ser ut som följer (ifall du har åtkomst):

{
    "api_version": "0.1",
    "data": [
        {
            "content": "{\"date\": \"YYYY-MM-DD\", \"folder\": \"/static/results/webbplats.se_yyyymmdd_hhmmss-summary_reports/\", \"base_url\": \"https://webbplats.se\"}",
            "date_modified": "2025-05-12T22:20:01",
            "format": "audit",
            "result_files": [
                "https://api.webperf.se/0.1/audit_file/?folder=webbplats.se-2025_05_12_18-results&file=accessibility_summary.json",
                "https://api.webperf.se/0.1/audit_file/?folder=webbplats.se-2025_05_12_18-results&file=performance_summary.json",
                "https://api.webperf.se/0.1/audit_file/?folder=webbplats.se-2025_05_12_18-results&file=seo_summary.json",
                "https://api.webperf.se/0.1/audit_file/?folder=webbplats.se-2025_05_12_18-results&file=best-practices_summary.json"
            ],
            "site_id": nnnn,
            "result_id": nnn,
            "title": "Audit Webbplats.se"
        }
    ],
    "result_count": 1,
    "timestamp": "2025-05-28 21:43:02.311244"
}

site_id är webbplatsens id-nummer, alltså samma som du skickade in. result_id är radens eget id. content är en textsträng med JSON för nyare rader; äldre rader har i stället en Python-dict-sträng med enkla citattecken, så tolka fältet tolerant. result_count är här ett riktigt heltal.

Hämta rapportfilerna

Filerna under result_files är inte öppet läsbara. Varje fil hämtas med samma api-key och site-id som listningen, och mappen måste tillhöra din webbplats – en giltig API-nyckel ger alltså inte åtkomst till någon annans rapporter. Anropa URL:en rakt av med dina headers:

Till exempel med curl:

curl -H "api-key: din-api-nyckel" -H "site-id: nnnn" \
  "https://api.webperf.se/0.1/audit_file/?folder=webbplats.se-2025_05_12_18-results&file=seo_summary.json"

Svarar 403 om nyckeln saknar behörighet till webbplatsen eller om mappen hör till någon annan, och 404 om filen inte finns. Tidigare låg de här filerna öppet på premium.webperf.se/static/results/; de gamla länkarna slutar fungera.

2.12 Kvarvarande krediter i din kvot

Beställningar kostar krediter: 1 per test i ett omtest, 15 per privat testad sida och 1 per sida i en audit. Här ser du hur mycket du har kvar innan du beställer, i stället för att få reda på det av ett felmeddelande.

Kvoten sätts antingen direkt på din webbplats eller härleds ur dess premiumnivå. Perioden är rullande 30 dygn – krediter frigörs alltså löpande, det finns ingen dag i månaden då allt nollställs.

Data i svaret är följande:

• site_id heltal med webbplatsens id-nummer, det du skickade in.
• monthly_quota heltal med webbplatsens tak för perioden.
• effective_limit heltal med samma tak. Ligger kvar för bakåtkompatibilitet.
• used heltal med förbrukade krediter de senaste 30 dygnen.
• available heltal med kvarvarande krediter. Aldrig under 0.
• period_days heltal med längden på det rullande fönstret, alltså 30.

Det kan se ut så här:

{
    "api_version": "0.1",
    "site_id": nnnn,
    "monthly_quota": 1500,
    "effective_limit": 1500,
    "used": 460,
    "available": 1040,
    "period_days": 30,
    "timestamp": "2026-08-06 09:12:44.102938"
}

Ingen kontotyp har obegränsad kvot. En webbplats utan premiumnivå får 0 rakt igenom och kan alltså inte beställa något.

3. Premium för webbyråer

Som webbyrå finns det en särskild premiumåtkomst. En del i det är att du kan hantera både din egen webbplats och kundernas. En annan är att det ger dig åtkomst till information som kan göra ditt säljarbete enklare. Det som är exklusivt för webbyråers premium listas nedan.

3.1 Vilka verktyg för webbanalys används hos webbplatser Webperf följer

Detta API kräver att du har Premium för webbyråer.

Svaret du får av API:t är en CSV-fil, separerad med semi-kolon. För knappt 4000 st webbplatser viktiga för ett digitalt Norden, främst Sverige.

Vilken utdata får du? Jo:

• title – vad är webbplatsens namn?
• url – vilken adress är det som testats?
• test_date – när gjordes det senaste testet av webbplatsen?
• ga_or_gtm – finns Google Analytics eller Google Tag Manager i koden?
• vizzit – hittas molntjänsten Vizzit i koden?
• siteimprove_analytics – har webbplatsen Siteimprove Analytics?
• matomo – existerar Matomo Analytics för webbanalys?
• piwik_pro – har webbplatsen Piwik PRO (Core eller Enterprise)
• fathom – finns Fathom Analytics på webbplatsen?
• plausible – spåras webbplatsen med Plausible Analytics?
• monsido_statistics – spåras webbplatsen med Monsido Statistics?
• hotjar – har webbplatsen Hotjar?
• Därefter, på samma sätt: adobe_analytics, new_relic, mixpanel, quantcast_measure, fullstory, cloudflare_insights, snowplow, klaviyo, ms_clarity, pingdom_rum och crazyegg.

Svaret levereras som text/plain. Utan nyckel, eller med en nyckel som saknar behörigheten, svarar API:t 400 respektive 403.

4. Webhook för dig med Webperf Premium

Webhooks är ett sätt att få signaler skickad till ditt API när en SaaS-tjänst har något att berätta. Som i det här fallet, att något av Webperfs tester körts och har ett testresultat till dig. Läs mer om webhooks på Webperf.se

För att dra nytta av webhooks via Webperf behöver du först och främst ha ett premiumkonto. Sätt upp en endpoint så du kan ta emot postningen från Webperf. Sedan konfigurerar du respektive webbplats inne i premium.webperf.se så vi vet var du vill ha ditt resultat skickat någonstans.

Nedan har du ett exempel på hur innehållet ser ut som du får postat till din endpoint. HTTP-anropet kommer ha en content-type med application/json och nedan payload. Du har två olika signaler om vilken sida det gäller i fallet med webhooks.

uri är adressen du i efterhand kan slå upp mot för att kolla allt om sidan så som Webperf ser på saken. Men ifall du testar många sidor kontinuerligt är det värt att veta om att för webhook finns också tested_url som direkt berättar vilken sida som testet gäller. I vanlig ordning är det vissa tester som inte utvärderar den URL:en utan istället går på din 404-sida, kollar mejlinställningar, etc. Men då vet du i alla fall vilken URL som kördes in som startpunkt.

        {
            "api_version": "undefined",
            "uri": "https://api.webperf.se/item/3843",
            "tested_url": "https://webperf.se",
            "timestamp": "2024-01-13T22:34:11.519410",
            "result_count": "1",
            "data": {
                "test_date": "2024-01-13T22:34:11.519410",
                "type_of_test": 4,
                "url": "https://webperf.se",
                "rating": 4.95,
                "check_report": "- Webbsidan kan ändå förbättras inom SEO.
                - Tryckmålen har inte lämplig storlek: 99 % av tryckmålen har lämplig storlek ( 4.40 betyg )
                - Alla bildelement har `[alt]`-attribut ( 5.00 betyg )
                - Dokumentet har en metabeskrivning ( 5.00 betyg )
                - Dokumentet har ett `<title>`-element ( 5.00 betyg )
                - Dokumentet har ett giltigt `hreflang`-värde ( 5.00 betyg )
                - Dokumentet har ett giltigt `rel=canonical`-värde ( 5.00 betyg )
                - Dokumentet har läsliga teckenstorlekar ( 5.00 betyg )
                - Dokumentet undviker plugin-program ( 5.00 betyg )
                - Har en `<meta name="viewport">`-tagg med `width` eller `initial-scale` ( 5.00 betyg )
                - Länkar har beskrivande text ( 5.00 betyg )
                - Länkarna är genomsökningsbara ( 5.00 betyg )
                - Sidan har en giltig HTTP-statuskod ( 5.00 betyg )
                - Sidan är inte blockerad från indexering ( 5.00 betyg )
                - robots.txt är giltig ( 5.00 betyg )",
                "check_report_a11y": "",
                "check_report_perf": "",
                "check_report_stand": "",
                "check_report_sec": "",
                "json_check_data": "{}"
            }
        }

5. Versionshistorik

Kort om de versioner som släppts och vad som är planen för nästa version.

• 0.1 (2022-08-15) initial version med öppna data (kommuner och regioner), samt tre endpoints för premium; få sin webbplats id-nummer, hämta aktuella testresultat i JSON-format och historiska genomsnittsbetyg.
• 0.1.1 (2023-07-15) starta ny körning av sin egen webbplats (Premium).
• 0.1.2 (2023-07-25) nya funktioner för premium och webbyråer:
  1. Privata tester av många sidor på din webbplats och få ut resultaten via API (Premium).
  2. Vilka webbplatser använder vilket webbanalysverktyg? Lista i CSV-format över samtliga publika webbplatser på Webperf.se och info om de använder Google Analytics, Matomo, Plausible, Piwik PRO, Fathom, Siteimprove Analytics eller Vizzit (kräver behörigheten Premium för webbyråer).
• 0.1.3 (2023-08-03) nu kan man även se om webbplatsen använder Monsido Statistics (Premium för webbyråer)
• 0.1.4 (2023-08-06) anger om webbplatsen använder Hotjar (Premium för webbyråer)
• 0.1.5 (2023-08-25) ifall du har premium och postar med din API-nyckel till din egen URI får du de beräknade betygen – kategoribetygen (Premium).
• 0.1.6 (2023-09-08) BREAKING CHANGES!
  1. Alla HTTP-headers som tidigare innehöll site_id eller api_key måste få sitt understreck ändrat till ett bindestreck. Alltså, site-id och api-key. Detta beror på ramverket på serversidan som i nyare versioner inte klarar av understreck. (Premium)
  2. Anrop för privata tester returnerar nu vilka endpoints man kommer hitta testerna på (Premium).
  3. Fler webbanalysverktyg för dig som vill veta vilka som använder vad. Nu finns även Adobe Analytics, New Relic, Mixpanel, Quantcast Measure, Fullstory, Cloudflare Insights, Snowplow, Klaviyo, Microsoft Clarity, Pingdom RUM och Crazyegg (kräver behörigheten Premium för webbyråer).
• 0.1.7 (2024-03-08) få läsbarhetsindex beräknat för en text. (Premium)
• 0.1.8 (2024-03-25) BREAKING CHANGES!
  1. BREAKING: Endpointen https://api.webperf.se/stats/ och https://api.webperf.se/0.1/stats/ ger nu ett annat svar. Se 2.1 Hämta era senaste betyg för hur det fungerar nu
  2. Ny funktion är att du med åtkomst till mer än en webbplats på Webperfs Premium kan nå samtliga med samma API-nyckel. För att se respektive webbplats endpoint kolla dokumentationen under 2.1 Hämta era senaste betyg.
• 0.1.9 (2024-11-21) hämta ut kategoriernas genomsnitts­betyg (Premium)
• 0.1.10 (2025-05-28) trigga en Audit (Premium)
• 1.0 (2025-08-04) refaktorerad kod, stabilare drift och börjat stödja OpenAPI 3.
• 1.0.1 (2025-08-14) Stödjer OpenAPI 3 och Swagger UI så du utan kunskaper inom programmering kan testa API:t.
• 1.0.2 (2026-08-04) BREAKING CHANGES! för 2.11 Hämta upp dina Premium Audits:
  1. BREAKING: Länkarna i result_files går inte längre till premium.webperf.se/static/results/ utan till den nya endpointen /audit_file/, som kräver samma api-key och site-id som listningen. Rapportfilerna är inte längre öppet läsbara.
  2. BREAKING: site_id innehåller nu webbplatsens id. Tidigare låg radens id där av misstag; det finns numera i result_id.
  3. Nytt format audit_v2 med två sammanfattningar till samt summaries.zip. Rader med formatet csv har inga result_files.
• 1.0.3 (2026-08-06) BREAKING CHANGES! för 2.10 Trigga en Premium Audit:
  1. BREAKING: content med en egen lista av URL:er stöds inte längre och ger statuskod 400. Auditen har aldrig kunnat utgå från en inskickad URL-lista – den crawlar alltid fram sidorna själv från startsidan – och listan hamnade dessutom i samma fält som sidantalet, vilket gjorde att beställningen kördes med auditorns standardantal i stället för det du betalade för.
  2. pages är obligatorisk och styr både hur många sidor som crawlas och vad beställningen kostar (1 kredit per sida). Kravet fanns i API:t redan tidigare men saknades i dokumentationen.
  3. Dokumentationen visade GET för endpointen; den har alltid varit POST. Svaret är ett JSON-objekt, inte en lista, och kvotspärren svarar 400 med Quota exceeded i stället för den gamla fyraveckorsregelns 429.
  4. BREAKING: ett privat engångstest kostar 15 krediter per sida i stället för 1, se 2.4 Starta privata tester. API:t tog 1 kredit medan webbgränssnittet på webperf.cloud tog 15 för exakt samma beställning, ur samma kreditkonto. Priset i webbgränssnittet är det som gäller.
  5. Nytt avsnitt: 2.12 Kvarvarande krediter i din kvot. Endpointen /quota/ har funnits ett tag men saknades i dokumentationen, så enda sättet att veta hur mycket man hade kvar var att logga in eller att få en beställning nekad. Samtidigt rättat att krediterna gäller en rullande 30-dagarsperiod, inte 4 veckor, och att beställningar som inte ryms faktiskt stoppas.
• 1.0.4 (2026-09-04) nya anrop, två rättade buggar och en genomgång av den här dokumentationen mot vad API:t faktiskt svarar:
  1. Ny endpoint /0.1/whoami/ som talar om vem nyckeln tillhör och hur många webbplatser den når, se 2.1. Billigaste sättet att kontrollera en nyckel.
  2. /0.1/stats/{id} tar query-parametrarna type_of_test och include_raw_data, så att du slipper hämta rådata för alla tester när du vill ha ett. Listningen /0.1/stats/ anger nu även title och website per webbplats.
  3. Rättat: /tools/lix/ svarade 200 med ett felmeddelande för texter under 50 ord. Nu 400.
  4. Rättat: /retest/ accepterade en föråldrad lista av test-id:n som saknade testerna 26–32. Tillåtna id:n följer nu de aktiva testerna i /v1/tests. Test 17 (pensionerat) accepteras inte längre.
  5. Rättat: pagination.total i /v1/sites räknades fel.
  6. Dokumentationen: 2.8 LIX är POST och har inget /0.1/-alias; 2.5 tar ingen HTTP-body; 2.2 har inget data_id; 2.4 och 2.11 visar nu det faktiska svaret; 2.6 listar de fyra fält som faktiskt kommer; 2.12 anger 15 krediter per privat sida; tal i de äldre endpointerna beskrivs som de textsträngar de är; och de öppna /v1/-endpointerna finns med under 1.4.

6. Tips på verktyg och resurser

För att använda Webperfs öppna data kan du egentligen fortsätta använda din webbläsare. Åtminstone ifall du bara vill ladda ner data. Men för premium-API:t behöver du skicka med en API-nyckel i din förfrågan, vilket görs enklast med appen Postman om du inte bygger ditt anrop i någon utvecklingsmiljö.

• Postman för att utforska och jobba med API:er. Finns för Mac, Linux och Windows, samt en du kan köra direkt i webbläsaren.
• Google Colab gör att du kan köra kod direkt i webbläsaren via Googles molntjänst. Stödjer Python-kod och miljön är en variant av Jupyter Notebook.
• Anaconda hjälper dig dels med virtuella miljöer med de olika beroenden man kan vilja ha, men är också en startpunkt för Jupyter Notebook för att ha en utforskande utvecklingsmiljö direkt i webbläsaren. Finns för Mac, Linux (inklusive RaspberryPi) och Windows.
• Visual Studio Code är en utvecklingsmiljö för alla möjliga språk. Finns till Mac, Linux och Windows.

Resurser:

• Vad alla it-chefer måste veta om API:er är en nyttig introduktion till vad API:er är bra till
• Sveriges dataportal är en katalog över datakällor och erbjuds av DIGG.
• Officiella portalen för europeiska data listar 1,5 miljoner dataset.
• Länkadedata.se erbjuder halvdagskurs i DCAT-AP, semantiska specifikationer, vitbok om länkade öppna data, etc.
• Sveriges dataportals community är en bra plats för dig som vill prata eller samarbeta om datakällor.