Skip to main content

Pigment Setup Guide

Prerequisites

  • A Pigment account with Workspace admin access.

Note: Only Workspace Admins can create API keys. The key returns only the data that its owner can see in Pigment, so create it with a user that has access to every view you want to sync.

Setup Guide

Step 1: Generate an API key

  1. Log in to your Pigment account.
  2. Open your Workplace settings and click API Keys.
  3. Click + Create API key.
  4. Enter a Name (for example Matia) and an Expiration date for the key. The key stops working on the expiration date, so choose a date well after you plan to keep syncing.
  5. Select Export as the Key type.
  6. Click Generate.
  7. Copy the API key. This is your API Key. You will need it to configure your connection.

Note: Keys in the old dashed format must be regenerated. If your key is in that format, generate a new one.

Step 2: Find your View IDs

  1. Open the Pigment list, metric, or table you want to sync.
  2. Find the view ID in the page URL, after viewId=. For example, if your URL is https://pigment.app/application/1234/tables/abcd?displayMode=Grid&viewId=abcd1234, your view ID is abcd1234.
  3. Repeat for every view you want to sync. You can enter multiple view IDs as comma-separated values.

Note: Pigment recommends creating a dedicated view for the API export.

Note: You cannot change the view IDs after you set up the connection. To change them, set up a new connection.

Step 3: Complete Configuration in Matia

  1. Enter the API Key.
  2. Enter the View IDs.
  3. Enter an Asset Name.
  4. (Optional) Enter an Asset Description.
  5. Select Owners.
  6. (Optional) Select Tags.
  7. Verify that your Pigment account is successfully connected by clicking on Test Connection.
  8. Click Connect.