api-referenceGET
GET
https://analytics.flowsery.com/analytics/api/v1/overviewHaal geaggregeerde analytics-statistieken van je website op.
Bearer-token (werkruimtetoken of website-API-sleutel)
Werkruimtetokens hebben een websiteselector nodig
Werkruimte-API-tokens hebben toegang tot elke website in de werkruimte. GeefwebsiteId of domain mee, zodat Flowsery weet welke website je wilt opvragen of wijzigen. Website-API-sleutels horen al bij één website, dus daar kun je de selector weglaten.Websiteselector
| Parameter | Type | Beschrijving |
|---|---|---|
websiteId | string | Website-ID om te gebruiken met een werkruimte-API-token. Laat weg als je authenticeert met een website-API-sleutel. |
domain | string | Websitedomein om te gebruiken met een werkruimte-API-token als er geen websiteId is opgegeven. Laat weg als je authenticeert met een website-API-sleutel. |
Queryparameters
| Parameter | Type | Beschrijving |
|---|---|---|
startAt | string | Startdatum/-tijd in ISO 8601. Standaard de laatste 30 dagen als je dit weglaat. |
endAt | string | Einddatum/-tijd in ISO 8601. Standaard nu als je dit weglaat. |
timezone | string | IANA-tijdzone-ID. Valt terug op de ingestelde tijdzone van de site. |
Filterparameters
| Parameter | Type | Beschrijving |
|---|---|---|
filter_country | string | Landnaam zoals /countries die teruggeeft, bijv. United States. Gebruik | voor meerdere waarden, ! om uit te sluiten en ~ om op een deel van de waarde te matchen. |
filter_region | string | Naam van de regio of staat zoals /regions die teruggeeft, bijv. California. |
filter_city | string | Naam van de stad. |
filter_device | string | Apparaattype: Desktop, Mobile of Tablet. Waarden zijn hoofdlettergevoelig. |
filter_browser | string | Browsernaam (Chrome, Safari, Firefox, Edge). Safari omvat automatisch ook Mobile Safari. |
filter_os | string | Besturingssysteem (Mac OS, Windows, iOS, Android). |
filter_referrer | string | Referrer zoals /referrers die teruggeeft: een bronnaam zoals Google voor herkende sites, anders het domein. |
filter_ref | string | De waarde van de URL-parameter ref. |
filter_source | string | De waarde van de URL-parameter source. |
filter_via | string | De waarde van de URL-parameter via. |
filter_utm_source | string | UTM-bron. |
filter_utm_medium | string | UTM-medium. |
filter_utm_campaign | string | UTM-campagne. |
filter_utm_term | string | UTM-term. |
filter_utm_content | string | UTM-content. |
filter_page | string | Paginapad of URL. |
filter_entry_page | string | Pad of URL van de instappagina. |
filter_hostname | string | Hostnaam/domein. |
filter_channel | string | Marketingkanaal. |
filter_goal | string | Goalnaam. |
Opmerkingen
Zonder datumbereik gebruikt de API standaard de laatste 30 dagen tot nu. bounceRate en conversionRate zijn percentages; avgSessionDuration en avgEngagedTime zijn seconden. Filterwaarden accepteren | voor meerdere waarden, ! om uit te sluiten en ~ om op een deel van de waarde te matchen.Voorbeeldverzoek (curl)
curl --request GET \
--url https://analytics.flowsery.com/analytics/api/v1/overview \
--header 'Authorization: Bearer <api-key>'200
{
"status": "success",
"data": [
{
"visitors": 12450,
"sessions": 16890,
"bounceRate": 65.32,
"avgSessionDuration": 246,
"avgEngagedTime": 187,
"revenue": 28450,
"renewalRevenue": 6320,
"refundedRevenue": 410,
"revenuePerVisitor": 2.29,
"conversionRate": 1.15,
"kpiValue": 28450,
"kpiPerVisitor": 2.29,
"kpiConversionRate": 1.15,
"currency": "USD"
}
]
}