Skip to main content

Getting started with the Attest Results API

Connect your Attest survey results directly to your BI tools and data workflows using a stable user level API key.

Introduction

The Attest Results API gives you direct, programmatic access to your study data. Instead of manually exporting files from Attest and re-uploading them elsewhere, you can pull results straight into the tools you already use, such as Power BI, Tableau, or your own data warehouse.

The API is aimed at insights professionals and data teams who want Attest data to sit alongside other data sources in their existing workflows, kept up to date without manual effort.

Note: The API is currently available to a smaller cohort of customers ahead of a wider release. Speak to Sales or the Customer Team for more information.


How it works

Generating your API key

  1. In your Attest dashboard, go to your Profile & Setting page.

  2. Generate a new API key. This is shown once, so save it somewhere secure straight away.

  3. Use this key to authenticate requests to the Attest API.

Each user has a single API key at a time. If you generate a new key, for example because your existing key has been compromised, this immediately invalidates the old one. There's currently no way to view or explicitly revoke a key separately, so generating a new one is how you rotate access.

What data you can access

The API currently gives you access to two things for any study: its structure (the questions asked, answer options, and audience) and its raw response data (one record per respondent, with their answers and demographic attributes). Together, these let you fully reconstruct and analyse a study outside Attest.

Access is read-only. You request data for a study using its study ID [found in the Results link URL], and results are returned unfiltered and unpaginated, so you can apply any filtering or transformation logic on your side.

Connecting to your tools

Full setup steps, authentication details, and the API reference are in the Attest developer documentation. If you're connecting a BI tool specifically, there's also a section on BI tools guide to get you started.


Common use cases

  • Automating your data pipeline. Pull results directly into a data warehouse (like Snowflake) or BI tool (like Power BI, Tableau, Looker, or Omni), removing the manual export and upload step entirely.

  • Cross-data analysis. Combine Attest data with other business data, such as sales figures, marketing spend, or brand tracking metrics, to understand what's driving changes in the numbers you care about.

  • Custom dashboards and reporting. Build reporting that stays up to date automatically, rather than being refreshed manually each time a new wave of results comes in.

  • Powering your own tools. Feed Attest data into internal systems, for example a natural language query tool for colleagues who don't use Attest directly.


Scope of release

  • Access is read-only. You cannot create, edit, or delete anything in Attest through the API.

  • Raw response-level data is available. Pre-aggregated exports, such as crosstabs, are not currently supported via API.

  • Data is retrieved by polling. Real-time or webhook-based delivery is not currently supported.

  • Each user has a single API key. Multiple named keys per user are not currently supported.

  • Service accounts are not currently supported. Each key is tied to an individual user.


FAQs

Do I need engineering support to get started?

No. You can generate your API key yourself from your Attest dashboard. Connecting it to a BI tool or custom script may still need some technical setup on your end.

Is the API available to all Attest customers?

Not yet. It's currently available to a smaller cohort of customers by request ahead of a wider release.

What happens if my API key is leaked?

Generate a new key straight away. This immediately invalidates the old one.

Can I get real-time updates when new results come in?

Not currently. You'll need to poll the API for updates rather than receive a push notification.

Can I filter which responses I get back?

Not at the query level currently. Requesting data for a study returns all responses; filtering happens on your end after retrieval.

Did this answer your question?