Analyze user behavior and analytics with Amplitude Dashboard REST API for event tracking and user insights
The Amplitude API allows you to analyze user behavior and track analytics data. You can monitor real-time active users, calculate revenue lifetime values, perform event segmentation analysis, create funnel conversion reports, and track individual user activity to gain comprehensive insights into your application’s usage patterns.
Required:
action
- The action to perform (get, analyze, track)entity
- The entity type (realtime, revenue, events, funnels, user)start
- Start date in YYYYMMDD formatend
- End date in YYYYMMDD formatOptional:
interval
- Time interval (5 minutes, daily, weekly, monthly)metric
- Metric type (ARPU, ARPPU, Total Revenue, Paying Users)segment
- Segment definitionsgroup_by
- Property to group byuser_id
- User identifier for user activitylimit
- Number of results to returnoffset
- Pagination offsetMonitor active user numbers with 5-minute granularity for the last two days.
Parameters:
interval
(optional) - Interval in minutes (default: 5)Example:
Response:
Calculate the lifetime value of new users with detailed revenue metrics.
Parameters:
start
(required) - First date in YYYYMMDD formatend
(required) - Last date in YYYYMMDD formatmetric
(optional) - Metric type: 0=ARPU, 1=ARPPU, 2=Total Revenue, 3=Paying Users (default: 0)interval
(optional) - Interval: 1=daily, 7=weekly, 30=monthly (default: 1)segment
(optional) - Segment definitions (JSON array)group_by
(optional) - Property to group byExample:
Response:
Analyze segmentation data for specific events with filtering and grouping.
Parameters:
event
(required) - Event definition (JSON object)start
(required) - Start date in YYYYMMDD formatend
(required) - End date in YYYYMMDD formatmetric
(optional) - Metric type for analysisinterval
(optional) - Interval (1, 7, or 30)segment
(optional) - Segment definitionsgroup_by
(optional) - Group by propertiesExample:
Response:
Analyze funnel conversion data across multiple events.
Parameters:
events
(required) - Array of event definitions (JSON)start
(required) - Start date in YYYYMMDD formatend
(required) - End date in YYYYMMDD formatconversion_window
(optional) - Conversion window in daysconversion_type
(optional) - Conversion window typesegment
(optional) - Segment definitionsgroup_by
(optional) - Group by propertiesExample:
Response:
Retrieve activity data for a specific user including all events and properties.
Parameters:
user
(required) - User identifieroffset
(optional) - Pagination offsetlimit
(optional) - Number of results (max 1000)Example:
Response:
Rate limits include 5 concurrent requests and 360 queries per hour for user endpoints. Cost-based model calculates as (days) × (conditions) × (query type cost). Concurrent limit is 1000 cost within 5 minutes. Hourly limit is 108,000 cost per hour. Time zone matches your Amplitude project settings. URL encode special characters in event names and properties. Built-in properties include version, country, city, region, language, platform, os, device. Custom user properties use gp:property_name format. Special event types include _active, _all, revenue_amount. Uses PinkConnect proxy connection. Authentication requires base64-encoded API key and secret key. Event filters support various operators like is, contains, greater than.