Skip to main content

Frequently Asked Questions: The Aspire API

Frequently asked questions about Aspire's API

P
Written by Product Solutions

Related Resources

Getting Started with Aspire's API

Technical Documentation

What data can I access today?

The Aspire API currently provides two analytics endpoints:

  • GET /v1/posts returns post-level data — every metric you'd see at the post level inside Aspire, across Instagram, TikTok, YouTube, and Pinterest.

  • GET /v1/members returns the same metrics rolled up to the creator level, with per-network and per-post-type breakdowns.

Both endpoints support filtering by date range, network, project, group, member, post type, and mention source.

How do I get started?

To create an API key:

  1. In Aspire, navigate to Settings → Integrations → Aspire API.

  2. Click Create API Key.

  3. Enter a descriptive name for the key.

  4. Select the permission scopes.

  5. Choose an expiration period.

  6. Click Create Key and copy the generated key, then click Done.

Important: For security reasons, the API key value is displayed only once. Store it in a secure location, such as a password manager, secrets vault, or your organization's credential manager.

After you click Done, the key cannot be viewed again. If it's lost, you'll need to generate a new one.

How do API permissions work?

API keys are permission-scoped, meaning each key can only access the endpoints associated with its assigned scopes.

Available scopes include:

  • read:social

  • read:affiliate

  • read:member

  • read:payment

  • read:product-fulfillment

For most social reporting use cases, read:social is the only scope required.

What do I need to make an API request?

You'll need two pieces of information:

  • API key — Used to authenticate your requests.

  • Client ID — Found in your Aspire workspace URL immediately following /client/.

The API documentation also includes an interactive request tool that lets you test endpoints and preview JSON responses before building your integration.

Can I filter the data?

Yes. Both analytics endpoints support filtering by:

  • Date range

  • Social network (Instagram, TikTok, YouTube, Pinterest)

  • Project

  • Group

  • Creator (member)

  • Post type

  • Mention source

    • Brand-initiated

    • Creator-submitted

    • Auto-discovered through social listening

  • Post status

    • Live

    • Expired

    • Deleted

You can also choose whether metrics are calculated over the selected date range or using lifetime values, depending on your reporting needs.

Can I sort and paginate results?

Yes, supported sorting includes metrics such as:

  • Impressions

  • Engagements

  • Engagement rate

  • Total Media Value (TMV)

  • View time

Pagination uses standard offset and limit parameters, with a maximum page size of 500 records.

Are there rate limits?

Yes. Standard API rate limits apply.

If you exceed the rate limit, the API returns a 429 response and you should back off and retry. Most reporting use cases should remain well below the rate limits because they're scheduled pulls, not real-time queries.

How are API keys secured?

Aspire follows several security best practices:

  • Keys are only displayed once when they are created.

  • Expiration (TTL) can be configured for 30 days, 60 days, 90 days, 1 year, or no expiration.

  • Least-privilege access is recommended by creating separate keys for each integration with only the permissions required.

Keys can be revoked at any time either through the Aspire settings or via the API, allowing individual integrations to be disabled without affecting others.

Who is the API intended for? Our team isn't technical.

The API is designed primarily for business intelligence (BI) and analytics teams. Once connected, marketing teams benefit from richer dashboards and automated reporting without needing to interact directly with the API.

If your organization doesn't have an internal technical team, your agency, implementation partner, or Aspire Support can help you get started.

Is there a sandbox environment?

Rather than a separate sandbox, the API documentation includes an interactive request tool that allows you to:

  • Execute live API requests

  • Inspect response formats

  • Validate requests before writing code

For most engineering teams, this is sufficient for designing and testing an integration.

How is this different from Aspire's existing integrations (Shopify, etc.)?

Native integrations (such as Shopify) are pre-built for specific workflows.

The Aspire API provides a flexible, programmatic interface for teams that want to:

  • Build custom applications

  • Connect Aspire to internal systems

  • Load data into BI platforms or data warehouses

  • Integrate with tools that Aspire doesn't natively support

What about affiliate, payment, or product fulfillment data?

The GET /v1/members endpoint returns payment information for each member, including affiliate commissions and product cost.

The API also includes dedicated permission scopes for:

  • read:affiliate

  • read:payment

  • read:product-fulfillment

These scopes provide the foundation for accessing additional Aspire data as those endpoints become available. Refer to the Technical Documentation for the latest endpoint availability.

Did this answer your question?