Features Pricing About Support Log in Get Started

Do you have an API?

Yes. Auware provides a developer API that lets you build custom integrations, automate campaign workflows, pull analytics into your own reporting tools, and connect Auware to the rest of your tech stack. API access is available on Starter plans and above.

Getting Your API Key

To create an API key, go to Settings and select the Developers tab. Click “Create API Key” and you will be prompted to provide:

  • Key Name - A descriptive label so you can identify what the key is used for, such as “Production Dashboard” or “Analytics Export Script.”
  • Expiration - Choose when the key expires: never, 30 days, 60 days, 90 days, or 1 year. Keys that never expire are convenient but less secure. For production integrations, consider setting an expiration and rotating keys periodically.
  • Permissions - Set access levels for two resource categories. Content controls access to campaigns, audiences, landing pages, and products. Analytics controls access to performance metrics and reports. Each resource can be set to None, Read, or Write independently.

When you click Create, Auware generates your API key and displays it once. Copy it immediately and store it securely - you will not be able to see the full key again. The key will look like aw_live_ followed by a long random string.

You can create up to 10 active API keys per store. Each key can have different permissions, which is useful when different parts of your system need different levels of access.

Authenticating API Requests

Every API request must include your key in the Authorization header as a Bearer token. For example, a request to list your campaigns would include the header Authorization: Bearer aw_live_your_key_here along with your request to the campaigns endpoint at https://app.auware.com/api/v1/stores/{your_store_id}/campaigns.

If the key is missing, expired, or revoked, you will receive a 401 Unauthorized response. If the key does not have the required permission for the endpoint you are calling, you will receive a 403 Forbidden response.

What You Can Do with the API

The API provides access to two main resource categories:

Content includes your campaigns, audiences, landing pages, products, and AI-generated copy. With read access, you can retrieve campaign details, list audiences, fetch landing page content, and pull product data. With write access, you can create campaigns, manage audiences, and trigger content generation programmatically.

Analytics includes performance metrics, traffic data, conversion funnels, and reporting. With read access, you can pull dashboard metrics, campaign performance data, audience comparisons, and channel attribution. With write access, you can manage scheduled reports and export configurations.

Common use cases include building agency dashboards that aggregate performance across client stores, automating campaign creation from a product feed, pulling analytics into business intelligence tools, and integrating Auware into larger marketing automation workflows.

Rate Limits

Each subscription tier has different rate limits to ensure fair usage:

Starter plans allow 30 API requests per day with a minimum polling interval of 60 minutes between identical requests. This is designed for light integration use cases like daily analytics exports.

Pro plans allow 5,000 requests per day with a minimum polling interval of 1 minute. This supports active integrations that need near-real-time data.

Agency plans allow 25,000 requests per day with a minimum polling interval of 1 minute. This is designed for agencies managing multiple stores with high-volume automation.

Rate limits reset at midnight UTC. Every API response includes headers that tell you your daily quota, how many requests remain, and when the quota resets, so you can build rate-limit-aware integrations.

If you exceed your rate limit, you will receive a 429 Too Many Requests response with a Retry-After header telling you how many seconds to wait before trying again.

Permission Levels by Tier

Starter plans are limited to read-only access for both content and analytics. This means you can pull data from Auware but cannot create or modify anything through the API.

Pro and Agency plans have full read and write access available. You can set each key’s permissions independently, so you might create a read-only key for your analytics dashboard and a read-write key for your campaign automation scripts.

Managing Your Keys

In the Developers tab, you can see all of your API keys with their name, a preview of the key prefix, permissions, creation date, last used timestamp, and status. You can update a key’s name or permissions at any time without generating a new key. If a key is compromised or no longer needed, you can revoke it with one click. Revoking a key is immediate and cannot be undone - any integration using that key will stop working instantly.

Usage is tracked per key, so you can see when each key was last used. This helps you identify unused keys that should be revoked and troubleshoot integrations that may not be connecting properly.

Did this answer your question?