HomeGuidesAPI Reference
Need Help?
API Reference
Need Help?

Get form periodic report

get
https://api.omnisend.com/api/forms//report/periodic

Get time-bucketed statistics for a form within a date range. When the granularity query param is provided it is used, but the request is rejected if that granularity is not available for the date range. When it is omitted the granularity is auto-determined from the date range.

Scopes:
forms.read

Rate limit: 400 requests per minute.

Path Params
string
required

Form ID (24 character hexadecimal)

Query Params
string
required

Start of the date range, inclusive (RFC3339, e.g. 2024-01-01T00:00:00Z)

string
required

End of the date range, inclusive (RFC3339, e.g. 2024-01-31T23:59:59Z)

string
enum

Time bucket granularity

Allowed:
Headers
string
required
Defaults to 2026-preview

API version that specifies the response format and behaviour

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?