Posty5 QR Code

Create and manage QR codes with Posty5. v1 is legacy: update and delete overwrite (last write wins)

Actions8

Get Analytics

AI-generated

Summary

Retrieve detailed analytics data for a specified QR code over a selectable date range, with options to customize the time interval, breakdown dimensions, and output format.

Inputs

  • QR Code ID (required) — The unique identifier of the QR code to fetch analytics for.
  • Range — Predefined or custom date range to query analytics, including options like last 7, 30, or 90 days, or a custom range with explicit start and end dates.
  • From (required) — The start date of the custom date range (used only if Range is set to Custom).
  • To (required) — The inclusive end date of the custom date range (used only if Range is set to Custom).
  • Interval — Granularity for the analytics series points: day, week (starting Monday), or month (starting on the 1st).
  • All Breakdowns My Plan Allows — Boolean to return every breakdown dimension available with your Posty5 plan. If false, specific breakdowns can be selected manually.
  • Breakdowns — Specific breakdown dimensions to include in analytics, such as browser, country, device, or channel, when not requesting all available breakdowns.
  • Output — Format of the output: full API response including totals, series, breakdowns, and metadata, or flattened series points as individual items with metadata.
  • Options — Additional options including Breakdown Rows limit per breakdown (1-50) and the IANA Time Zone to count days in (defaults to workflow time zone).

Output shape

a single JSON object representing the analytics report for the QR code.

The output includes totals, series data points grouped by the specified interval, breakdowns according to requested dimensions, and metadata. If Output = 'Series as Items', each series point is returned as a separate item, each including metadata. Date ranges respecting your Posty5 plan limits will succeed; unauthorized breakdowns or ranges cause a detailed error. Time zone affects date boundaries for analytics.

Examples

Example 1: Fetch analytics for QR code with ID 'abc123' over the last 30 days with daily intervals and all breakdowns allowed by your plan.

Set QR Code ID as 'abc123', Range as 'Last 30 Days', Interval as 'Day', and check 'All Breakdowns My Plan Allows'. Output defaulted to full response.

Example 2: Fetch analytics for QR code with ID 'xyz789' over a custom date range from 2024-01-01 to 2024-01-31, with weekly intervals, returning only browser and country breakdowns.

Set QR Code ID as 'xyz789', Range as 'Custom', From as 2024-01-01, To as 2024-01-31, Interval as 'Week', uncheck 'All Breakdowns My Plan Allows', select 'Browser' and 'Country' in Breakdowns, and output as full response.

Links

Discussion