Get an ambassador's referral analytics

GET

/ambassadors/{id}/analytics

All-time referral analytics for one ambassador: clicks by traffic type, conversions, attributed funds per currency, and breakdowns by campaign, UTM source and day.

Callers may read their own analytics; anyone else's answers 403.

Authorizations

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The ambassador's profile UUID.

Type

string

Required

Format

"uuid"

Responses

The analytics (bare object)

Content-Type

application/json

"string"

GET

/ambassadors/{id}/analytics

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI