To interact with Pigment, add a step in a chain that uses a Pigment connection command.
Requirements
To enable these commands, an IT admin must first configure the Pigment connector.
Export list
To export the data of a specific list, add an Export list command.
Equivalent API call: https://pigment.app/api/swagger/#/Export/post_api_export_list__listId_
Properties
| Property | Detail |
|---|---|
| List ID | Enter the ID of the list to export. |
| Property technical names |
Enter the technical names of the Pigment List properties that you want to export. These should be listed in order. If no names are entered, all properties will be exported. |
| List filter |
Enter the Pigment List items that you want to export. If no lists are entered, all properties will be exported. |
| Property filters |
Enter the Pigment List property filters that you want to export. If no filters are entered, all properties will be exported. |
| Friendly headers |
When checked, the exported CSV will display "friendly" names in headers. When unchecked, the CSV will display technical names. |
Outputs
| Output | Output Type |
|---|---|
| List | CSV file |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Successful | Successful |
| 1 | Error | Error |
Export metric
To export the data of a specific metric, add an Export metric command.
Equivalent API call: https://pigment.app/api/swagger/#/Export/post_api_export_metric__metricId_
Properties
| Property | Detail |
|---|---|
| Metric ID | Enter the ID of the metric to export. |
| Scenarios |
Enter the Scenario IDs containing the Pigment Metric data to export. If no scenarios are entered, the default scenario is exported. |
| Dimension filters |
Enter the Pigment Dimension filters that you want to export. If no filters are entered, all filters will be exported. |
| Friendly headers |
When checked, the exported CSV will display "friendly" names in headers. When unchecked, the CSV will display technical names. |
Outputs
| Output | Output Type |
|---|---|
| List | CSV file |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Successful | Successful |
| 1 | Error | Error |
Export table
To export the data of a specific table, add an Export table command.
Equivalent API call: https://pigment.app/api/swagger/#/Export/post_api_export_table__tableId_
Properties
| Property | Detail |
|---|---|
| Table ID | Enter the ID of the table to export. |
| Metrics |
Enter the Metric IDs belonging to the Pigment Table data that you want to export. These should be listed in order. If no Metric IDs are entered, all metrics will be exported. |
| Scenarios |
Enter the Scenario IDs containing the Pigment Metric data to export. If no scenarios are entered, the default scenario is exported. |
| Dimension filters |
Enter the Pigment Dimension filters that you want to export. If no filters are entered, all filters will be exported. |
| Friendly headers |
When checked, the exported CSV will display "friendly" names in headers. When unchecked, the CSV will display technical names. |
Outputs
| Output | Output Type |
|---|---|
| List | CSV file |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Successful | Successful |
| 1 | Error | Error |
Export view
To export the data of a specific view, add an Export view command.
Equivalent API call: https://pigment.app/api/swagger/#/Export/get_api_export_view__viewId_
Properties
| Property | Detail |
|---|---|
| View ID | Enter the ID of the view to export. |
Outputs
| Output | Output Type |
|---|---|
| List | CSV file |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Successful | Successful |
| 1 | Error | Error |
Import CSV
To import a CSV file, add an Import CSV command.
Equivalent API call: https://pigment.app/api/swagger/#/ImportApi/post_api_import_push_csv
Properties
| Property | Detail |
|---|---|
| Configuration ID | Enter the Configuration ID from Pigment that defines the destination of the file. |
| FilePath | Enter the file path for the CSV that you want to import. |
Outputs
| Output | Output Type |
|---|---|
| Import | JSON |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Successful | Successful |
| 1 | Error | Error |