FOfourthwall
Analytics Reports

Get a report

Changed on

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Fetches a specific analytics report for a date range

get/open-api/v1.0/reports/{reportId}

Request

  • Base URL
    https://api.fourthwall.com
  • URL
    https://api.fourthwall.com/open-api/v1.0/reports/{reportId}
  • Auth
    • OAuth 2
      Implicit: https://auth.staging.fourthwall.com/auth/realms/Fourthwall/protocol/openid-connect/auth
      Scopes: analytics_read
    • or HTTP basic

Path parameters

reportIdstring required

Query parameters

fromstring date-time required
tostring date-time required
aggregationTimezonestring required

Timezone in ISO-8601 format (e.g., Europe/Warsaw for Warsaw)

Example:Europe/Warsaw
aggregationPrecision'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' required

Response

OK

reportIdstring required
columnsstring[] required
rowsobject[] required
summaryunknown

Changes

  • d02dd5a76313Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status