---
title: "Get Facebook Page Analytics"
method: GET
path: "/locations/{locationId}/facebook-analytics"
tags: ["Profile Analytics"]
---

# Get Facebook Page Analytics

`GET /locations/{locationId}/facebook-analytics`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/locations/{locationId}/facebook-analytics`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/locations/:locationId/facebook-analytics/get.ts> (a function with typed inputs; its response is checked against the schema)

This API retrieves profile analytics data from Facebook for a specific location.

## Path parameters

- `locationId` string, required

## Query parameters

- `fromDate` string, date
- `toDate` string, date

## Headers

- `Authorization` string, required

## Response `200`

Successful response

- object
  - `data` object
    - `facebookInsights` object
      - `ctaAction` InsightMetric[]: The number of times the CTA on the page was clicked
        - `startTime` string, date-time: Start time of the analytics period
        - `value` integer: Metric value for the period
      - `directionsAction` InsightMetric[]: The number of times directions for the particular location was requested
        - `startTime` string, date-time: Start time of the analytics period
        - `value` integer: Metric value for the period
      - `phoneAction` InsightMetric[]: The number of times the call number for the location was requested
        - `startTime` string, date-time: Start time of the analytics period
        - `value` integer: Metric value for the period
      - `views` InsightMetric[]: The number of times the page was viewed
        - `startTime` string, date-time: Start time of the analytics period
        - `value` integer: Metric value for the period
      - `websiteAction` InsightMetric[]: The number of times the website URL for the location was requested
        - `startTime` string, date-time: Start time of the analytics period
        - `value` integer: Metric value for the period

## Other responses

- `401`: Unauthorized
- `404`: Location not found

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)
