Skip to main content

Documentation Index

Fetch the complete documentation index at: https://heyhumm.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Humm runs event segmentation queries against your Amplitude project. Ask about user engagement trends, compare cohorts, or break down events by any property.

​
Source Types

SaaS (Live)

Humm queries the Amplitude API directly in real time. Data is never stored by Humm.

Sync

Humm syncs your Amplitude data into your warehouse via Airbyte, then queries the copy. Better performance for large datasets and lets you join Amplitude data with everything else in your warehouse.
See Choosing a Source Type for help deciding.

​
Tools

ToolDescription
AMPLITUDE_RUN_AGGREGATIONExecute event segmentation queries with metrics, filtering, grouping, and date ranges
AMPLITUDE_LIST_COHORTSList all cohorts in the Amplitude project
AMPLITUDE_GET_EVENT_TYPESRetrieve all event types in the project
AMPLITUDE_GET_EVENT_CATEGORIESRetrieve all event categories
AMPLITUDE_FIND_USERSearch for users by Amplitude ID, device ID, or user ID

​
Aggregation Queries

The AMPLITUDE_RUN_AGGREGATION tool is the primary way to query Amplitude data. It supports event segmentation with flexible metrics and grouping.

​
Metrics

MetricDescription
uniquesUnique users (default)
totalsTotal event count
pct_dauPercentage of daily active users
averageAverage events per user
sumsSum of event property values
value_avgAverage of event property values
formulaCustom formula across two events

​
Parameters

ParameterRequiredDescription
eYesPrimary event definition (event type, filters, group-by)
startYesStart date in YYYYMMDD format
endYesEnd date in YYYYMMDD format
mNoMetric type (default: uniques)
iNoTime interval: 1 (daily), 7 (weekly), 30 (monthly), -3600000 (hourly)
gNoPrimary group-by property
sNoSegment filters on user population
e2NoSecond event (for formula queries)
formulaNoCustom formula (requires m=formula and both e/e2)

​
Event Definition

{
  "event_type": "Purchase",
  "filters": [
    {
      "subprop_type": "event",
      "subprop_key": "category",
      "subprop_op": "is",
      "subprop_value": ["Electronics"]
    }
  ]
}

​
Special Event Types

Event TypeDescription
_activeAny active event
_allAll events
ce:nameCustom events (prefix with ce:)

​
Group-By Properties

Built-in properties: country, city, region, platform, os, device_type, version, paying. For custom properties, use the gp: prefix (e.g., gp:plan_name).

​
Filter Operators

OperatorDescription
is / is notExact match
contains / does not containSubstring match
less / greaterNumeric comparison
less or equal / greater or equalNumeric comparison
set is / set is notSet membership

​
Query Constraints

IntervalMax Date Range
Real-time (-300000)2 days
Hourly (-3600000)7 days
Daily (1)365 days
Rate limit: 5 concurrent queries.

​
Authentication

API Toke

Connect securely via OAuth. Authorize Humm to access your Amplitude project.