Het Dataplatform van de gemeente Amsterdam gaat het gebruik van een identificatie key bij het aanroepen van haar API's vanaf 1 februari 2024 verplicht stellen. Vanaf 1 februari 2024 kun je de API's van het Dataplatform niet meer zonder een key gebruiken. Vraag tijdig een key aan via dit aanvraagformulier. Doe je dit niet, dan werkt je applicatie of website vanaf 1 februari 2024 niet meer. Dit geldt voor alle API's die op deze pagina gedocumenteerd zijn.
Door de API key kunnen we contact houden met de gebruikers van onze API's. Zo kunnen we gebruikers informeren over updates. Daarnaast krijgen we hiermee inzicht in het gebruik van de API's en in wie welke dataset via de API bevraagt. Ook voor dataeigenaren is dit waardevolle informatie.
Meer info:
Pagina API key aanvragen
Technische documentatie
Vragen? Mail naar dataplatform@amsterdam.nl
De volgende velden zijn beschikbaar:
Veldnaam | Type | Identifier | Omschrijving |
---|---|---|---|
id
|
String | ☑ | Id van de scope |
naam
|
String | Naam van de scope (zoals in amsterdam-schema) | |
packageNaam
|
String | Naam van de Myaccess package van deze scope | |
packageId
|
String | Object ID van de Myaccess package van deze scope | |
packageUrl
|
String | URL van de Myaccess package van deze scope |
De volgende query-parameters zijn te gebruiken:
Parameter | Autorisatie | Mogelijke waarden | Werking |
---|---|---|---|
id
|
FP/MDW | Tekst | Test op exacte waarde (== ) |
id[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
id[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
id[isempty]
|
FP/MDW | true of false |
Test of de waarde leeg is (== '' / != '' ) |
id[like]
|
FP/MDW | Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. |
id[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
naam
|
FP/MDW | Tekst | Test op exacte waarde (== ) |
naam[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
naam[isempty]
|
FP/MDW | true of false |
Test of de waarde leeg is (== '' / != '' ) |
naam[like]
|
FP/MDW | Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. |
naam[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
naam[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
packageId
|
FP/MDW | Tekst | Test op exacte waarde (== ) |
packageId[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
packageId[isempty]
|
FP/MDW | true of false |
Test of de waarde leeg is (== '' / != '' ) |
packageId[like]
|
FP/MDW | Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. |
packageId[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
packageId[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
packageNaam
|
FP/MDW | Tekst | Test op exacte waarde (== ) |
packageNaam[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
packageNaam[isempty]
|
FP/MDW | true of false |
Test of de waarde leeg is (== '' / != '' ) |
packageNaam[like]
|
FP/MDW | Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. |
packageNaam[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
packageNaam[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
packageUrl
|
FP/MDW | Tekst | Test op exacte waarde (== ) |
packageUrl[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
packageUrl[isempty]
|
FP/MDW | true of false |
Test of de waarde leeg is (== '' / != '' ) |
packageUrl[like]
|
FP/MDW | Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. |
packageUrl[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
packageUrl[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
De volgende velden zijn beschikbaar:
Veldnaam | Type | Identifier | Omschrijving |
---|---|---|---|
id
|
String | ☑ | Id |
startDateTime
|
Datetime | Begintijd van de responsetijd meting | |
endDateTime
|
Datetime | Begintijd van de reponsetijd meting | |
endpoint
|
String | Dataset endpoint | |
minResponseTime
|
Number | Snelste responsetijd gemeten | |
maxResponseTime
|
Number | Langste responstijd gemeten | |
avgResponseTime
|
Number | Gemiddelde responstijd gemeten |
De volgende query-parameters zijn te gebruiken:
Parameter | Autorisatie | Mogelijke waarden | Werking |
---|---|---|---|
avgResponseTime
|
FP/MDW | Getal | Test op exacte waarde (== ) |
avgResponseTime[gte]
|
FP/MDW | None | Test op groter dan of gelijk (>= ). |
avgResponseTime[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
avgResponseTime[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
avgResponseTime[gt]
|
FP/MDW | None | Test op groter dan (> ). |
avgResponseTime[lt]
|
FP/MDW | None | Test op kleiner dan (< ). |
avgResponseTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
avgResponseTime[lte]
|
FP/MDW | None | Test op kleiner dan of gelijk (<= ). |
endDateTime
|
FP/MDW | yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (== ) |
endDateTime[gte]
|
FP/MDW | None | Test op groter dan of gelijk (>= ). |
endDateTime[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
endDateTime[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
endDateTime[gt]
|
FP/MDW | None | Test op groter dan (> ). |
endDateTime[lt]
|
FP/MDW | None | Test op kleiner dan (< ). |
endDateTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
endDateTime[lte]
|
FP/MDW | None | Test op kleiner dan of gelijk (<= ). |
endpoint
|
FP/MDW | Tekst | Test op exacte waarde (== ) |
endpoint[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
endpoint[isempty]
|
FP/MDW | true of false |
Test of de waarde leeg is (== '' / != '' ) |
endpoint[like]
|
FP/MDW | Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. |
endpoint[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
endpoint[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
id
|
FP/MDW | Tekst | Test op exacte waarde (== ) |
id[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
id[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
id[isempty]
|
FP/MDW | true of false |
Test of de waarde leeg is (== '' / != '' ) |
id[like]
|
FP/MDW | Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. |
id[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
maxResponseTime
|
FP/MDW | Getal | Test op exacte waarde (== ) |
maxResponseTime[gte]
|
FP/MDW | None | Test op groter dan of gelijk (>= ). |
maxResponseTime[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
maxResponseTime[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
maxResponseTime[gt]
|
FP/MDW | None | Test op groter dan (> ). |
maxResponseTime[lt]
|
FP/MDW | None | Test op kleiner dan (< ). |
maxResponseTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
maxResponseTime[lte]
|
FP/MDW | None | Test op kleiner dan of gelijk (<= ). |
minResponseTime
|
FP/MDW | Getal | Test op exacte waarde (== ) |
minResponseTime[gte]
|
FP/MDW | None | Test op groter dan of gelijk (>= ). |
minResponseTime[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
minResponseTime[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
minResponseTime[gt]
|
FP/MDW | None | Test op groter dan (> ). |
minResponseTime[lt]
|
FP/MDW | None | Test op kleiner dan (< ). |
minResponseTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
minResponseTime[lte]
|
FP/MDW | None | Test op kleiner dan of gelijk (<= ). |
startDateTime
|
FP/MDW | yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (== ) |
startDateTime[gte]
|
FP/MDW | None | Test op groter dan of gelijk (>= ). |
startDateTime[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
startDateTime[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
startDateTime[gt]
|
FP/MDW | None | Test op groter dan (> ). |
startDateTime[lt]
|
FP/MDW | None | Test op kleiner dan (< ). |
startDateTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
startDateTime[lte]
|
FP/MDW | None | Test op kleiner dan of gelijk (<= ). |
De volgende velden zijn beschikbaar:
Veldnaam | Type | Identifier | Omschrijving |
---|---|---|---|
id
|
String | ☑ | Id |
startDateTime
|
Datetime | Begintijd van het aantal requests | |
endDateTime
|
Datetime | Eindtijd van het aantal requests | |
endpoint
|
String | Dataset endpoint | |
failedRequests
|
Integer | Het aantal requests die niet succesvol zijn uitgevoerd HTTP_4XX en HTTP_5XX | |
successfullRequests
|
Integer | Het aantal requests die succevol zijn uitgevoerd HTTP_200 |
De volgende query-parameters zijn te gebruiken:
Parameter | Autorisatie | Mogelijke waarden | Werking |
---|---|---|---|
endDateTime
|
FP/MDW | yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (== ) |
endDateTime[gte]
|
FP/MDW | None | Test op groter dan of gelijk (>= ). |
endDateTime[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
endDateTime[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
endDateTime[gt]
|
FP/MDW | None | Test op groter dan (> ). |
endDateTime[lt]
|
FP/MDW | None | Test op kleiner dan (< ). |
endDateTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
endDateTime[lte]
|
FP/MDW | None | Test op kleiner dan of gelijk (<= ). |
endpoint
|
FP/MDW | Tekst | Test op exacte waarde (== ) |
endpoint[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
endpoint[isempty]
|
FP/MDW | true of false |
Test of de waarde leeg is (== '' / != '' ) |
endpoint[like]
|
FP/MDW | Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. |
endpoint[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
endpoint[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
failedRequests
|
FP/MDW | Geheel getal | Test op exacte waarde (== ) |
failedRequests[gte]
|
FP/MDW | None | Test op groter dan of gelijk (>= ). |
failedRequests[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
failedRequests[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
failedRequests[gt]
|
FP/MDW | None | Test op groter dan (> ). |
failedRequests[lt]
|
FP/MDW | None | Test op kleiner dan (< ). |
failedRequests[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
failedRequests[lte]
|
FP/MDW | None | Test op kleiner dan of gelijk (<= ). |
id
|
FP/MDW | Tekst | Test op exacte waarde (== ) |
id[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
id[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
id[isempty]
|
FP/MDW | true of false |
Test of de waarde leeg is (== '' / != '' ) |
id[like]
|
FP/MDW | Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. |
id[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
startDateTime
|
FP/MDW | yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (== ) |
startDateTime[gte]
|
FP/MDW | None | Test op groter dan of gelijk (>= ). |
startDateTime[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
startDateTime[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
startDateTime[gt]
|
FP/MDW | None | Test op groter dan (> ). |
startDateTime[lt]
|
FP/MDW | None | Test op kleiner dan (< ). |
startDateTime[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
startDateTime[lte]
|
FP/MDW | None | Test op kleiner dan of gelijk (<= ). |
successfullRequests
|
FP/MDW | Geheel getal | Test op exacte waarde (== ) |
successfullRequests[gte]
|
FP/MDW | None | Test op groter dan of gelijk (>= ). |
successfullRequests[not]
|
FP/MDW | None | Test of waarde niet overeenkomt (!= ). |
successfullRequests[isnull]
|
FP/MDW | true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
successfullRequests[gt]
|
FP/MDW | None | Test op groter dan (> ). |
successfullRequests[lt]
|
FP/MDW | None | Test op kleiner dan (< ). |
successfullRequests[in]
|
FP/MDW | Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
successfullRequests[lte]
|
FP/MDW | None | Test op kleiner dan of gelijk (<= ). |