Skip to main content

Use Alia's public API

Pull analytics and other data using Alia's public API

Written by Joel Pednaud

Alia has a public API that you can use to pull analytics, campaign, and other data.

View documentation here: https://api.alia-prod.com/v1/docs

You can create and manage API access keys in your settings.

What the API supports

The read API (read:events, read:segments) supports the same granularity, filters, and groupings available in the app itself. This includes per-campaign and per-step metrics and answer distributions.

Current limitations

  • No write or management API. Campaigns, steps, targeting rules, and other configuration can only be edited through the dashboard, not via the API.

  • No Alia webhooks. Alia does not offer its own webhooks. Real-time events such as popup viewed, question answered, and signup captured can be consumed through the JavaScript SDK instead. This is separate from Shopify's native customer webhooks, which do fire on an Alia signup: because Alia writes through Shopify's standard Admin API, customers/create and customers/update fire exactly as they would for a manual edit in the Shopify admin, and consent updates fire customers/update as well.

  • No individual attributed-order feed. There is no API endpoint for pulling a feed of individual attributed orders. This data is only available through a manual export run by the support team on request.

JavaScript SDK events

The SDK fires these browser events, which can be captured and forwarded anywhere, including Segment, Customer.io, or your own reporting stack:

  • alia:campaignMatched

  • alia:popupView

  • alia:popupClose

  • alia:signup

  • alia:pollAnswered

  • alia:rewardClaimed

This is the full set. More granular steps, such as each individual question in a Mini Quiz, are not exposed as separate events.

There is no native Segment integration. These events are the supported path for sending Alia data into a customer data platform.

Related Articles
Did this answer your question?