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
- Log in to your Pigment account.
- Open your Workplace settings and click API Keys.
- Click + Create API key.
- 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. - Select Export as the Key type.
- Click Generate.
- 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
- Open the Pigment list, metric, or table you want to sync.
- Find the view ID in the page URL, after
viewId=. For example, if your URL ishttps://pigment.app/application/1234/tables/abcd?displayMode=Grid&viewId=abcd1234, your view ID isabcd1234. - 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
- Enter the API Key.
- Enter the View IDs.
- Enter an Asset Name.
- (Optional) Enter an Asset Description.
- Select Owners.
- (Optional) Select Tags.
- Verify that your Pigment account is successfully connected by clicking on Test Connection.
- Click Connect.