GET/api/v4/locations/{locationId}/facebook-analytics

Facebook-Analysedaten für einen Standort abrufen

Gibt tägliche Interaktionsmetriken einer Facebook-Seite für einen Standort über einen Datumsbereich zurück.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Pfad

NameTypErforderlichBeschreibung
locationIdstringerforderlichLocation ID, either the Base64 Relay id (e.g. TG9jYXRpb246MTgwMDI4OQ==) or the raw numeric database id (e.g. 1800289). Both forms resolve to the same location.

Query

NameTypErforderlichBeschreibungStandard
fromDatestringoptionalStart of the range (YYYY-MM-DD). Defaults to a recent window when omitted.—
toDatestringoptionalEnd of the range (YYYY-MM-DD).—

Antworten

200Daily Facebook Page interaction metrics. Each metric is a time-series array; a metric is `null` when no data exists for the range or the Page is not connected.
Response
{  "data": {    "facebookInsights": {      "views": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 120 }      ],      "ctaAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 5 }      ],      "directionsAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 3 }      ],      "phoneAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 2 }      ],      "websiteAction": [        { "startTime": "2025-06-01T00:00:00+00:00", "value": 9 }      ]    }  }}
401Unauthenticated, missing or invalid API key.

Gibt tägliche Interaktionsdaten einer Facebook-Seite für einen Standort zurück. Jede Metrik ist ein Array von Zeitreihenpunkten mit einem startTime (dem Tag, für den die Daten zusammengefasst wurden) und einem value. Die Facebook-Seite des Standorts muss verbunden sein.

Verfügbare Metriken:

  • views: Seitenaufrufe insgesamt
  • ctaAction: Klicks auf den Call-to-Action-Button der Seite
  • directionsAction: Routenanfragen über die Seite
  • phoneAction: über die Seite initiierte Anrufe
  • websiteAction: Klicks von der Seite zur Website

Beide id-Formen funktionieren im Pfad

Wie die anderen Analyse-Endpunkte akzeptiert facebook-analytics die Base64-Relay-id (TG9jYXRpb246MTgwMDI4OQ==) oder die unverarbeitete numerische id (1800289), und beide verweisen auf denselben Standort. Verwenden Sie vorzugsweise die Relay-id, da diese von den Lese-Endpunkten zurückgegeben wird. Bei einem Wert, der keiner der beiden Formen entspricht, gibt der Endpunkt {"data":{"facebookInsights":null},"errors":[...]} mit dem Status 200 zurück.

Shell
curl -s 'https://listingsapi.com/api/v4/locations/TG9jYXRpb246MTgwMDI4OQ==/facebook-analytics?fromDate=2025-06-01&toDate=2025-06-30' \  -H "Authorization: API $LISTINGSAPI_KEY"

Interaktionen dem CTA-Button zuordnen

Wenn ein Standort auf seiner Seite einen Call-to-Action-Button mit „Jetzt buchen“ oder „Jetzt anrufen“ verwendet, können Sie mit ctaAction und phoneAction quantifizieren, wie viele dieser Klicks der Button während eines Kampagnenzeitraums ausgelöst hat. Beachten Sie, dass jede Metrik als null (nicht als leeres Array) zurückgegeben wird, wenn die Seite keine Daten für den Zeitraum hat oder nicht verbunden ist; prüfen Sie vor dem Iterieren auf null. Kombinieren Sie diese Daten mit den Analysedaten von Google und Bing, um eine einheitliche Leistungsübersicht über mehrere Plattformen hinweg zu erstellen.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/facebook-analytics' \  -H "Authorization: API $LISTINGSAPI_KEY"