Sign in

v84

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-0985248447.1 KB
Reports
Human Referrals

Get Referrals Report V1

Get referral traffic report from the daily aggregated materialized view.

This endpoint queries pre-aggregated daily referral data, making it efficient for large date ranges and high-traffic sites.

post/v1/reports/referrals

Request body

date_interval'hour' | 'day' | 'week' | 'month' | 'year' | 'relative_week'

Date interval for the report. (only used with date dimension)

dimensionsstring[]

Dimensions to group the report by.

metricsstring[] required
order_byobject

Custom ordering of the report results.

The order is a record of key-value pairs where:

  • key is the field to order by, which can be a metric or dimension
  • value is the direction of the order, either 'asc' for ascending or 'desc' for descending.

When not specified, the default order is the first metric in the query descending.

domainstring required

Domain to query logs for.

start_datestring date-time required

Start date for logs. Accepts: YYYY-MM-DD, YYYY-MM-DD HH:MM, YYYY-MM-DD HH:MM:SS, or full ISO timestamp.

end_datestring date-time

End date for logs. Accepts same formats as start_date. Defaults to now if omitted.

organization_idstring uuid nullable

Example request

{
  "order_by": {
    "date": "asc"
  }
}

Response

Successful Response