domainAnalytics

The primary tool for event counts and traffic analysis. Use this for questions like "how many purchases today?", "what's the traffic breakdown?", or "how many errors last week?".

This should be the first tool used for any analytics question. For drilling down into specific channels or events, follow up with domainAnalyticsProvider or domainAnalyticsEvent.

Parameters

Parameter
Type
Required
Description

domainId

string (UUID)

Yes

The domain ID (tagId). Get this from the domains tool.

teamId

string (UUID)

Yes

The team ID the domain belongs to.

type

enum

Yes

What to group by: status (success/error counts), name (by event name), or provider (by channel).

range

number

Yes

Number of time units to look back.

rangeType

enum

Yes

Time unit: MINUTE, HOUR, or DAY.

status

number

Yes

Filter by status: 1 for successful events, 0 for errors.

timezone

string

Yes

IANA timezone, e.g., America/New_York.

Output

Returns time-series data with event counts grouped by the selected type. Each data point includes a timestamp and count.

Examples

"How many purchases did we have today?"

Uses type: "name", range: 24, rangeType: "HOUR", status: 1.

"Show me the traffic breakdown by channel for the last 7 days"

Uses type: "provider", range: 7, rangeType: "DAY", status: 1.

"How many errors in the last hour?"

Uses type: "status", range: 60, rangeType: "MINUTE", status: 0.

Last updated

Was this helpful?