See how it works: Read studies through the API

API for integrations

Leia estudos, resultados e respostas de fora do UXTap com chaves só de leitura.

2 minutes read

On this page

Connect an integration using a key and read scopes.

Purpose

Query authorized data outside the UXTap interface.

When to use it

To bring studies and results into your own integration.

Before you start

  • Administrator permission and required authentication
  • A server-side secret store

Example

Query studies using read:studies and follow the next-page cursor.

Step by step

  1. Open API for integrations. Open Settings and find API for integrations. Click OpenAPI contract to review read endpoints, filters and pagination. To list studies, find GET /api/v1/studies and confirm the data needed before creating a key. /openapi.json.
  1. Create a minimal key. Click New key. Enter a name such as Research dashboard, select required scopes and expiry; keep read:studies to list studies. Click Continue, confirm Current password and Create key. If you need to set a password, follow the displayed email instructions. read:studies · read:results · read:sessions only if needed.
  1. Store and query. Click Copy key before Done and store it on your integration server. Call GET /api/v1/studies with Authorization: Bearer and the key. Check the authorized response and follow the contract cursor; do not place the key in a URL or public browser code. No key in the browser · Cursor pagination.
  1. Monitor usage. Return to API for integrations and check key status, expiry and Last used; review daily usage when displayed. When retiring the integration, click Revoke, confirm your password and check Revoked status. The integration should handle 429 by respecting retry-after. Insufficient scope · Expiry · Limit.

How to read the result

  • A key with defined expiry and scopes
  • Read queries and monitorable usage

Cautions and limitations

  • The API is read-only and does not use cookies or URL keys.
  • read:sessions may include answer text; grant it only if needed.
  • Changing a password or signing out all devices may revoke keys.

Continue with the interactive guide

Read studies through the API

Was this helpful?

Is something missing? Write to contato@paineltap.com.br.