Skip to content

Reporting API

Flow statistics for activity in a timeframe

POSThttps://email.growthdept.ai/api/flow-values-reports

The request body can be up to 5 MB.

Rate limits

Burst: 1/s

Steady: 2/m

Daily: 225/day

Tier XS. See rate limits for how requests are counted.

Scopes

flows:read

Operation id

query_flow_values The same operation as in Klaviyo's API. OpenAPI document

Query parameters

array of strings

Attributes of flow-values-report resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

string

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      flow-values-report
    • idstring

    • attributesobjectrequired

      attributes: 5 fields
      • statisticsarray of stringsrequired

      • timeframeone ofrequired

        One option: object
        • keystringrequired

          Show 14 allowed values
          last_12_monthslast_30_dayslast_365_dayslast_3_monthslast_7_dayslast_90_dayslast_monthlast_weeklast_yearthis_monththis_weekthis_yeartodayyesterday
        One option: object
        • startstringrequired

        • endstringrequired

      • conversion_metric_idstringrequired

      • group_byarray of strings

      • filterstringcan be null

    • relationshipsobject

    • metaobject

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataobjectrequired

    data: 3 fields
    • typestringrequired

      flow-values-report
    • attributesobjectrequired

      attributes: 1 field
      • resultsarray of objectsrequired

        results: 2 fields
        • groupingsobjectrequired

        • statisticsobjectrequired

    • relationshipsobject

      relationships: 2 fields
      • flowsobject

        flows: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            flow
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • flow-messagesobject

        flow-messages: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            flow-message
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject