Skip to main content
Configview reads your Dovetail workspace through the Dovetail public API (https://dovetail.com/api), using a personal API token that a workspace admin creates in Dovetail. Configview sends only GET requests. It never creates, changes or deletes anything in Dovetail. You will end up with 1 required secret (DOVETAIL_API_TOKEN) in Configview when setup is complete.
Scope of this integration today. Configview reads who is a member of your Dovetail workspace (name, work email, job title, role and workspace admin flag), the research projects and channels (names, author, folder, created date), how many data items each project holds, how many data items were added per project per month over the last 90 days, and, on Enterprise workspaces in the IP allowlist beta, API key metadata (label, owner, created, expiry). It never reads notes, docs, insights, highlights, tags, transcripts, recordings or files, contacts, channel data points, or the titles of any research item, and it never calls those endpoints.

Read this first: tokens belong to a person and expire after 30 days

  • A Dovetail API token acts as the user who created it and sees what that user can see. Create it as a workspace admin, ideally a dedicated user (for example configview@yourcompany.com), so the member list and counts are complete.
  • Each token is valid for 30 days. After that every collector fails with a 401 and the health check turns red. Put a monthly reminder in your calendar, create a new token and paste it into DOVETAIL_API_TOKEN. Dovetail has no refresh flow for personal tokens.
  • When creating the token choose only these scopes: user:read, project:read, channel:read, note:read (this scope also covers listing data items; Configview reads only their project, created date and deleted flag), and optionally ip_allowlist:read for the API keys table.

What the Dovetail API does not tell Configview

The API has no last-active dates, 2FA or SSO status, pending invites, project visibility or project member lists, teams, integrations list or audit log. Configview cannot answer who has gone quiet, which projects are shared outside the workspace, or what people did. Only the author of each project is known.

What you need

  • A Dovetail workspace and a user who can open account settings and create an API token
  • For the API keys table: an Enterprise workspace enrolled in the IP allowlist beta (contact Dovetail support). Other plans skip that table without error.

Step 1: Open the Dovetail page in Configview

https://{companyname}.configview.com/admin/integrations/dovetail

Step 2: Create the token

  1. Signed in to Dovetail as the workspace admin, open your avatar menu, then Account settings
  2. Under API keys enter a label such as Configview, pick the scopes above and create the key
  3. Copy the token now (it starts with api.). Dovetail shows it only once.
  4. In Configview paste it into DOVETAIL_API_TOKEN under Credentials and click the save icon

Step 3: Connect and verify

  1. Click Connect. Configview creates its tables and schedules every collector at your default run time:
  1. Click Verify now. The health check reads the secret, calls GET /v1/token-info, then reads one user.
If a check fails: 401 means the token is mistyped, revoked or older than 30 days (create a new one). 403 means a scope is missing or your IP is not on the workspace allowlist. 429 means the per-minute limit was hit; retry in a minute.

Data Tables

Each table has a run_at column and keeps only the newest run. No raw API objects are stored.

Rate limits

Dovetail allows 200 REST requests per minute per workspace, shared by every token. Configview paces at 120 per minute, reads 100 rows per page and waits as long as the Retry-After header says after a 429. Data Usage pages through every data item created in the last 90 days (100 per request), and Projects makes one request per project, so large workspaces take a few minutes.

Known gaps and things to check on the first run

These come from the published API reference; no live tenant has been tested yet.
  • Base URL. https://dovetail.com/api is taken from the documented example and the IP allowlist server list. If calls return 404, check the subdomain form (https://<workspace>.dovetail.com/api).
  • Pagination. Configview sends page[limit]=100 and follows page.next_cursor through page[start_cursor] while has_more is true.
  • Filter syntax. filter[project_id] and filter[created_at][gte] are sent as deep-object query parameters. If counts equal the workspace total, the filter was ignored.
  • Counts. data_count is page.total_count of a one-row list read. Whether it includes soft-deleted items is not documented; deleted projects are not counted at all.
  • Scopes. Whether note:read is enough to list data items is taken from the scope table. If Data Usage is empty or Projects shows no counts, check the token’s scopes.
  • Author ids. Project authors are assumed to carry the same id as /v1/users. If the “author no longer a member” question over-reports, check that match.
  • Roles. role can be null for a member; those show as UNKNOWN. Workspace admins are flagged separately.

Things worth knowing

Leavers. A project whose author or an API key whose owner is not in the member roster usually means the person left. An API key keeps the access of the user who created it, so review those first. Keys that never expire. On the Enterprise IP allowlist beta, a key with no expiry date stays valid until revoked.

What isn’t collected

  • Notes, docs, insights, highlights, tags and tag boards, transcripts, recordings and files, comments
  • Channel data points, themes and topics, contacts (your research participants)
  • The titles and content of data items (only project, created date and deleted flag are read to count them)
  • Token values and raw API objects