Add-on Metrics Catalog

This page lists all metrics available through either the Alexa AI CLI or the Alexa+ Add-on API.

For the CLI, use the alexa-ai list-addon-metrics and alexa-ai get-addon-metrics CLI commands.
For the API, use the ListAddOnMetrics and GetAddOnMetrics operations.

Use this reference to find the correct metric names, supported stats, and dimensions for your queries.

How to read the tables

Each table lists the metrics for a specific family and category combination:

Step — The funnel step order (for TaskCompletion metrics). Use this to understand the sequence of the customer journey.
Metric name — The machine-readable name to pass in --metric or --queries.
Label — A human-readable description of what the metric measures.
Supported stats — The aggregation statistics you can use with --stat.
Supported dimensions — Dimensions available for filtering with --locale, --country, or the dimensions field in --queries.
Aggregation periods — Available values for --period.

The scope for a metric can be at the add-on level, the category level, or both, depending on the metric. For example, the account linking metrics are scoped to the add-on. All categories for the add-on return the same account linking metric. The engagement metrics support both scopes. You can retrieve these metrics for the entire add-on, or for a specific category with the --category flag. See the description before each table for the supported scopes for the listed metrics.

AccountLinking

Account linking metrics track the customer journey through your add-on’s account linking flow. These are add-on-level metrics—no --category flag is needed.

Step	Metric name	Label	Supported stats	Supported dimensions	Aggregation periods
1	`CUSTOMERS_INITIATED`	Customer accounts that initiated account linking	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
2	`CUSTOMERS_COMPLETED`	Customer accounts that completed account linking	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
3	`CUSTOMERS_DROPPED_OFF`	Customer accounts that dropped off	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
4	`COMPLETION_RATE`	Account Linking completion rate	`RATE`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
5	`CUSTOMERS_WITH_ERROR`	Customer accounts with error	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
6	`TOKEN_REVOCATIONS`	Token revocations	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
7	`TOTAL_LINKED_ACCOUNTS`	Total linked customer accounts	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`

Permission

Permission metrics track how customers grant and revoke permissions for your add-on. These are add-on-level metrics—no --category flag is needed.

Step	Metric name	Label	Supported stats	Supported dimensions	Aggregation periods
1	`CUSTOMERS_INITIATED`	Customer accounts that initiated permission	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
2	`CUSTOMERS_COMPLETED`	Customer accounts that completed permission	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
3	`CUSTOMERS_DROPPED_OFF`	Customer accounts that dropped off	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
4	`COMPLETION_RATE`	Permission completion rate	`RATE`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
5	`CUSTOMERS_WITH_ERROR`	Customer accounts with error	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
6	`TOKEN_REVOCATIONS`	Token revocations	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`
7	`TOTAL_LINKED_ACCOUNTS`	Total linked customer accounts	`UNIQUE_COUNT`	`AlexaAI.Country`	`P1D`, `P1W`, `P1M`

Engagement

Engagement metrics measure active customer usage of your add-on. These metrics are available at both the add-on level and the category level.

Add-on level

Use these without a --category flag to see engagement across your entire add-on.

Metric name	Label	Supported stats	Supported dimensions	Aggregation periods
`DAA`	Daily active customer accounts	`UNIQUE_COUNT`	`AlexaAI.Locale`, `AlexaAI.Country`	`P1D`
`WAA`	Weekly active customer accounts	`UNIQUE_COUNT`	`AlexaAI.Locale`, `AlexaAI.Country`	`P1W`
`MAA`	Monthly active customer accounts	`UNIQUE_COUNT`	`AlexaAI.Locale`, `AlexaAI.Country`	`P1M`

Category level

Use these with --category to see engagement for a specific category integration (for example, --category HomeServices or --category RestaurantReservation).

Metric name	Label	Supported stats	Supported dimensions	Aggregation periods
`DAA`	Daily active customer accounts	`UNIQUE_COUNT`	`AlexaAI.Locale`, `AlexaAI.Country`	`P1D`
`WAA`	Weekly active customer accounts	`UNIQUE_COUNT`	`AlexaAI.Locale`, `AlexaAI.Country`	`P1W`
`MAA`	Monthly active customer accounts	`UNIQUE_COUNT`	`AlexaAI.Locale`, `AlexaAI.Country`	`P1M`

TaskCompletion

Task completion metrics track the end-to-end customer funnel for each category integration. Each metric represents a step in the task flow. Use --family TaskCompletion with --category to retrieve the full funnel for a category. All TaskCompletion metrics support the following:

Stats: UNIQUE_COUNT, COUNT
- UNIQUE_COUNT — Unique customer accounts that completed a given funnel step.
- COUNT — Total request count.
Dimensions: AlexaAI.Locale, AlexaAI.Country
Group by: AlexaAI.ErrorCode
Aggregation periods: P1D, P1W

HomeServices

Step	Metric name	Label
1	`REQUEST_RECEIVED`	Service request started
2	`MESSAGE_PRO_REQUEST_STARTED`	Customer started browsing pros
3	`PROFESSIONALS_SHARED`	Customer viewed professionals list
4	`PRO_DETAILS_SHARED`	Customer viewed pro details
5	`APPOINTMENT_DETAILS_REQUESTED`	Appointment details requested
6	`BOOKING_QUESTION_ANSWERED`	Customer answered booking questions
7	`RETRIEVE_PHONE_NUMBER_FROM_ALEXA_PROFILE`	Customer phone number retrieved
8	`EDIT_MODE_TRIGGERED`	Customer edited booking details
9	`APPOINTMENT_SUMMARY_SHARED`	Appointment summary shared with customer
10	`REQUEST_CONFIRMATION_SENT`	Customer confirmed request
11	`PRO_MEETS_REQUIREMENTS`	Professional meets requirements
12	`MESSAGE_PRO_REQUEST_COMPLETED`	Inquiry Message sent to professional
13	`BOOKING_REQUEST_STARTED`	Auto-match booking started
14	`BOOKING_REQUEST_COMPLETED`	Booking request completed
15	`NOTIFICATION_ENGAGEMENT`	Customer engaged with notification
16	`BOOKINGS_RETRIEVED`	Customer viewed bookings
17	`BOOKING_CANCELLED`	Cancelled a booking
18	`BOOKING_RESCHEDULED`	Rescheduled a booking

RestaurantReservation

Step	Metric name	Label
1	`SEARCH_RESTAURANTS`	Search restaurants
2	`CHECK_IF_RESTAURANT_SUPPORTS_RESERVATIONS`	Check if restaurant supports reservations
3	`GET_AVAILABILITY`	Restaurant availability retrieved
4	`MAKE_RESERVATION`	Reservation confirmed
5	`GET_RESERVATIONS`	Customer viewed reservations
6	`MODIFY_RESERVATION`	Customer modified reservation
7	`CANCEL_RESERVATION`	Reservation cancelled

Get Started

Build with the MCP Toolkit

Build with the Category SDK

Testing

Certification

Reference

How to read the tables

AccountLinking

Permission

Engagement

Add-on level

Category level

TaskCompletion

HomeServices

RestaurantReservation

​How to read the tables

​AccountLinking

​Permission

​Engagement

​Add-on level

​Category level

​TaskCompletion

​HomeServices

​RestaurantReservation

​Related topics

How to read the tables

AccountLinking

Permission

Engagement

Add-on level

Category level

TaskCompletion

HomeServices

RestaurantReservation

Related topics