---
canonical_url: "https://docs.composio.dev/toolkits/pigment"
markdown_url: "https://docs.composio.dev/toolkits/pigment.md"
product: "platform"
version: null
last_updated: null
---

# Pigment

Pigment is a business planning platform for importing, modeling, exporting, and automating workspace data.

- **Category:** business intelligence
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 26
- **Triggers:** 0
- **Slug:** `PIGMENT`
- **Version:** 00000000_00

## Tools

### Download File

**Slug:** `PIGMENT_DOWNLOAD_FILE`

Download the raw bytes of one file from a Pigment application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | string | Yes | Pigment file to download. |
| `application_id` | string | Yes | Pigment application containing the file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export List

**Slug:** `PIGMENT_EXPORT_LIST`

Download a Pigment List as CSV through v1 with property selection, item and property filters, and formatting options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | List block to export. |
| `encoding` | string ("Utf8WithBom" | "Utf8WithoutBom") | No | CSV UTF-8 encoding mode. |
| `date_format` | string ("Legacy" | "Iso8601") | No | Date format. Pigment v1 defaults to Iso8601 when omitted. |
| `list_filter` | array | No | List item modality IDs to include. Empty or null includes all items. |
| `field_delimiter` | string ("Semicolon" | "Comma") | No | CSV field delimiter. Pigment defaults to Semicolon. |
| `friendly_headers` | boolean | No | Use friendly List and property names in CSV headers. Null or false uses technical names. |
| `property_filters` | array | No | Property filters to apply to the List export. |
| `decimal_separator` | string ("Comma" | "Dot") | No | CSV decimal separator. Pigment defaults to Dot. |
| `property_technical_names` | array | No | Properties to export, in order. Null exports all properties ordered by technical name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export List (Legacy)

**Slug:** `PIGMENT_EXPORT_LIST_LEGACY`

Download a List as CSV through Pigment's officially published unversioned legacy endpoint with all documented filters and formatting options. Prefer the current Export List action for new workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | List block to export. |
| `encoding` | string ("Utf8WithBom" | "Utf8WithoutBom") | No | CSV UTF-8 encoding mode. |
| `date_format` | string ("Legacy" | "Iso8601") | No | Date format. Omit or pass null to retain the legacy endpoint default. |
| `list_filter` | array | No | List item modality IDs to include. Empty or null includes all items. |
| `field_delimiter` | string ("Semicolon" | "Comma") | No | CSV field delimiter. Pigment defaults to semicolon. |
| `friendly_headers` | boolean | No | Use friendly List and property names in CSV headers. Null or false uses technical names. |
| `property_filters` | array | No | Property filters to apply to the List export. |
| `decimal_separator` | string ("Comma" | "Dot") | No | CSV decimal separator. Pigment defaults to dot. |
| `property_technical_names` | array | No | Properties to export, in order. Null exports all properties ordered by technical name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Metric

**Slug:** `PIGMENT_EXPORT_METRIC`

Download a Pigment Metric as CSV through v1 with scenarios, deprecated dimension filters, recursive filters, and formatting options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filters` | array | No | Deprecated dimension filters retained for contract parity. When both filters and export_filter are set, Pigment combines them with AND. |
| `encoding` | string ("Utf8WithBom" | "Utf8WithoutBom") | No | CSV UTF-8 encoding mode. |
| `metric_id` | string | Yes | Metric block to export. |
| `scenarios` | array | No | Scenario IDs to export. Null or an empty list exports only the default scenario without a scenario column. |
| `date_format` | string ("Legacy" | "Iso8601") | No | Date format. The v1 endpoint defaults to Iso8601 when omitted. |
| `export_filter` | object | No | Recursive filter. Set exactly one branch matching type; And and Or contain non-empty arrays of filters of this same shape. |
| `field_delimiter` | string ("Semicolon" | "Comma") | No | CSV field delimiter. Pigment defaults to Semicolon. |
| `friendly_headers` | boolean | No | Use friendly metric names in exported CSV headers. |
| `decimal_separator` | string ("Comma" | "Dot") | No | CSV decimal separator. Pigment defaults to Dot. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Metric (Legacy)

**Slug:** `PIGMENT_EXPORT_METRIC_LEGACY`

Download a Metric as CSV through Pigment's officially published unversioned legacy endpoint with scenarios, deprecated and recursive filters, and all documented formatting options. Prefer the v1 action for new workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filters` | array | No | Deprecated dimension filters retained for contract parity. When both filters and export_filter are set, Pigment combines them with AND. |
| `encoding` | string ("Utf8WithBom" | "Utf8WithoutBom") | No | CSV UTF-8 encoding mode. |
| `metric_id` | string | Yes | Metric block to export. |
| `scenarios` | array | No | Scenario IDs to export. Null or an empty list exports only the default scenario without a scenario column. |
| `date_format` | string ("Legacy" | "Iso8601") | No | Date format. This legacy endpoint defaults to Legacy when omitted. |
| `export_filter` | object | No | Recursive filter. Set exactly one branch matching type; And and Or contain non-empty arrays of filters of this same shape. |
| `field_delimiter` | string ("Semicolon" | "Comma") | No | CSV field delimiter. Pigment defaults to Semicolon. |
| `friendly_headers` | boolean | No | Use friendly metric names in exported CSV headers. |
| `decimal_separator` | string ("Comma" | "Dot") | No | CSV decimal separator. Pigment defaults to Dot. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Table

**Slug:** `PIGMENT_EXPORT_TABLE`

Download a Pigment Table as CSV through v1 with metrics, scenarios, filters, selected fields, and formatting options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Ordered CSV columns. Each field requires type and source_id, including an explicit null source_id for ScenarioField. |
| `filters` | array | No | Deprecated dimension filters retained for contract parity. When both filters and export_filter are set, Pigment combines them with AND. |
| `metrics` | array | No | Metric IDs to include in the export. |
| `encoding` | string ("Utf8WithBom" | "Utf8WithoutBom") | No | CSV UTF-8 encoding mode. |
| `table_id` | string | Yes | Table block to export. |
| `scenarios` | array | No | Scenario IDs to export. Null or an empty list exports only the default scenario without a scenario column. |
| `date_format` | string ("Legacy" | "Iso8601") | No | CSV date format. This v1 endpoint defaults to Iso8601 when omitted. |
| `export_filter` | object | No | Recursive filter. Set exactly one branch matching type; And and Or contain non-empty arrays of filters of this same shape. |
| `field_delimiter` | string ("Semicolon" | "Comma") | No | CSV field delimiter. Pigment defaults to Semicolon when omitted. |
| `friendly_headers` | boolean | No | Use friendly metric names in CSV headers when true. |
| `decimal_separator` | string ("Comma" | "Dot") | No | CSV decimal separator. Pigment defaults to Dot when omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Table (Legacy)

**Slug:** `PIGMENT_EXPORT_TABLE_LEGACY`

Download a Table as CSV through Pigment's officially published unversioned legacy endpoint with metrics, scenarios, filters, selected fields, and formatting options. Prefer the current Export Table action for new workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Ordered CSV columns. Each field requires type and source_id, including an explicit null source_id for ScenarioField. |
| `filters` | array | No | Deprecated dimension filters retained for contract parity. When both filters and export_filter are set, Pigment combines them with AND. |
| `metrics` | array | No | Metric IDs to include in the export. |
| `encoding` | string ("Utf8WithBom" | "Utf8WithoutBom") | No | CSV UTF-8 encoding mode. |
| `table_id` | string | Yes | Table block to export. |
| `scenarios` | array | No | Scenario IDs to export. Null or an empty list exports only the default scenario without a scenario column. |
| `date_format` | string ("Legacy" | "Iso8601") | No | CSV date format. This legacy endpoint defaults to Legacy when omitted. |
| `export_filter` | object | No | Recursive filter. Set exactly one branch matching type; And and Or contain non-empty arrays of filters of this same shape. |
| `field_delimiter` | string ("Semicolon" | "Comma") | No | CSV field delimiter. Pigment defaults to Semicolon when omitted. |
| `friendly_headers` | boolean | No | Use friendly metric names in CSV headers when true. |
| `decimal_separator` | string ("Comma" | "Dot") | No | CSV decimal separator. Pigment defaults to Dot when omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export View

**Slug:** `PIGMENT_EXPORT_VIEW`

Download a Pigment view as CSV through the v1 endpoint, optionally choosing comma or semicolon delimiters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | View to export. |
| `field_delimiter` | string ("Semicolon" | "Comma") | No | CSV field delimiter. Pigment defaults to Semicolon when omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export View (Legacy)

**Slug:** `PIGMENT_EXPORT_VIEW_LEGACY`

Download a view as CSV through Pigment's officially published unversioned legacy endpoint; prefer v1 for new workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | View to export. |
| `date_format` | string ("Legacy" | "Iso8601") | No | Date format. This legacy endpoint defaults to Legacy when omitted. |
| `field_delimiter` | string ("Semicolon" | "Comma") | No | CSV field delimiter. Pigment defaults to Semicolon when omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Data Flow Status

**Slug:** `PIGMENT_GET_DATA_FLOW_STATUS`

Get the current status and per-step results of a Pigment Data Flow execution.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_flow_execution_id` | string | Yes | Execution ID returned by Trigger Data Flow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Import Status

**Slug:** `PIGMENT_GET_IMPORT_STATUS`

Get v1 status for a CSV, integration, list-copy, or metric-copy import, optionally including the detailed report.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `import_id` | string | Yes | Import or copy pipeline execution ID. |
| `include_detailed_report` | boolean | No | Include detailed counts, impacted blocks, auto-created modalities, and skipped-data details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Import Status (Legacy)

**Slug:** `PIGMENT_GET_IMPORT_STATUS_LEGACY`

Get CSV import status through Pigment's officially published unversioned legacy endpoint; prefer the v1 action for new workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `import_id` | string | Yes | Legacy import execution ID to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Applications

**Slug:** `PIGMENT_LIST_APPLICATIONS`

List Pigment applications visible to the Modeling Metadata API key owner.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Application Snapshots

**Slug:** `PIGMENT_LIST_APPLICATION_SNAPSHOTS`

List scheduled, in-progress, completed, and failed Pigment application snapshots.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blocks

**Slug:** `PIGMENT_LIST_BLOCKS`

List visible Pigment Lists, Transaction Lists, Metrics, and Tables, optionally for one application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `application_id` | string | No | Application to filter by. OpenAPI marks this optional, while Pigment's prose examples treat it as needed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Data Flows

**Slug:** `PIGMENT_LIST_DATA_FLOWS`

List the Data Flows visible in one Pigment application.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `application_id` | string | Yes | Pigment application whose Data Flows to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Files

**Slug:** `PIGMENT_LIST_FILES`

Return one cursor-controlled page of file metadata for a Pigment application, newest first. Each page contains at most 1000 files.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor from this action's previous response. It retains the application ID; omit application_id when continuing. |
| `application_id` | string | No | Pigment application whose files to list. Required for the first page; omit it when continuing with a cursor. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Import Configurations

**Slug:** `PIGMENT_LIST_IMPORT_CONFIGURATIONS`

List Pigment import configurations, optionally narrowing the results by application and block.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `block_id` | string | No | Block to filter by. OpenAPI marks this optional, while Pigment's prose examples treat it as needed. |
| `application_id` | string | No | Application to filter by. OpenAPI marks this optional, while Pigment's prose examples treat it as needed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Views

**Slug:** `PIGMENT_LIST_VIEWS`

List Pigment view metadata, optionally narrowing the results by application and block.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `block_id` | string | No | Block to filter by. OpenAPI marks this optional, while Pigment's prose examples treat it as needed. |
| `application_id` | string | No | Application to filter by. OpenAPI marks this optional, while Pigment's prose examples treat it as needed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Push CSV Import

**Slug:** `PIGMENT_PUSH_CSV_IMPORT`

Upload CSV bytes to start a Pigment v1 import and return an import ID for status checks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `csv_file` | object | Yes | CSV file content to import. |
| `content_type` | string ("text/csv" | "application/octet-stream") | No | Documented media type for the raw binary request body. |
| `configuration_id` | string | Yes | Saved Pigment import configuration to run. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Push CSV Import (Legacy)

**Slug:** `PIGMENT_PUSH_CSV_IMPORT_LEGACY`

Upload CSV bytes to start an import through Pigment's officially published unversioned legacy endpoint; prefer v1 for new workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `csv_file` | object | Yes | CSV file content to import. |
| `content_type` | string ("text/csv" | "application/octet-stream") | No | Documented media type for the raw binary request body. |
| `configuration_id` | string | Yes | Saved Pigment import configuration to run. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Push Looker Import

**Slug:** `PIGMENT_PUSH_LOOKER_IMPORT`

Start a Pigment v1 Looker import from a saved configuration; the official contract declares no request body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `configuration_id` | string | Yes | Saved Looker import configuration to trigger. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Push Looker Import (Legacy)

**Slug:** `PIGMENT_PUSH_LOOKER_IMPORT_LEGACY`

Start a Looker import through Pigment's officially published unversioned legacy endpoint; the documented operation has no request body. Prefer the current Push Looker Import action for new workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `configuration_id` | string | Yes | Saved Looker import configuration to trigger. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Trigger Data Flow

**Slug:** `PIGMENT_TRIGGER_DATA_FLOW`

Start one Pigment Data Flow execution and return its execution ID for status checks. The flow may perform irreversible actions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_flow_id` | string | Yes | Data Flow to execute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Trigger Import

**Slug:** `PIGMENT_TRIGGER_IMPORT`

Trigger a configured integration import, list-to-list copy, or metric-to-metric copy and return its import ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `configuration_id` | string | Yes | Import or copy configuration Pigment should execute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File

**Slug:** `PIGMENT_UPLOAD_FILE`

Upload one file to a Pigment application and return the created file's metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File to upload; its filename becomes the name shown in Pigment. |
| `application_id` | string | Yes | Pigment application that will own the uploaded file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |