Skip to main content
POST
/
v1
/
reports
/
referrals
JavaScript
import Profound from '@profoundai/client';

const client = new Profound({
  apiKey: process.env['PROFOUND_API_KEY'], // This is the default and can be omitted
});

const reportResponse = await client.reports.getReferralsReport({
  domain: 'domain',
  metrics: ['visits'],
  start_date: '2019-12-27T18:11:19.117Z',
});

console.log(reportResponse.data);
{
  "info": {
    "total_rows": 123,
    "query": {}
  },
  "data": [
    {
      "metrics": [
        123
      ],
      "dimensions": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
metrics
enum<string>[]
required
Available options:
visits,
last_visit
​
domain
string
required

Domain to query logs for.

​
start_date
string<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.

​
date_interval
enum<string>
default:day

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

Available options:
hour,
day,
week,
month,
year,
relative_week
​
dimensions
enum<string>[]

Dimensions to group the report by.

Available options:
date,
path,
referral_source
​
order_by
Order By · object

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.

Example:
{ "date": "asc" }
​
pagination
Pagination · object

Pagination settings for the report results.

​
end_date
string<date-time>

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

​
organization_id
string<uuid> | null
​
metric_filters
NumericMetricFilter · object[]

Numeric filters applied after report metrics are calculated.

​
filters
(PathFilter · object | ReferralSourceFilter · object)[]

Filters for referrals report.

Filter by request path

Response

Successful Response

Base response model for reports.

​
info
Info · object
required

Base model for report information.

​
data
Result · object[]
required