# Pigment

> Read applications, blocks, views and files, export data, and run imports and data flows.

App · 15 actions. Web page: https://docs.lodol.com/docs/integrations/pigment

## Actions

### Export list

Export list.

**Inputs**

- List (`list_id`, text, required): The ID of the list to export
- Property technical names (`property_technical_names`, list): List of the property technical to be exported. The properties will be exported in that order. If null, all properties of the list will be exported ordered by their technical name.
- List filter (`list_filter`, list): List of modalities of the list to filter in. Empty or null means all.
- Property filters (`property_filters`, list): List of property filters.
- Friendly headers (`friendly_headers`, true/false): If true, the exported CSV header will display list and properties friendly names. If null or false, it will display technical names.
- Date format (`date_format`, text): Defines how Date values in the response should be formatted. Usage of the 'Legacy' option is not recommended, the format will either be '01/21/2054', in other cases '10/12/2024 00:00:00 +00:00'. 'Iso8601' will format dates like '2054-01-21'. One of: `Legacy`, `Iso8601`.
- Field delimiter (`field_delimiter`, text): Field separator, defaults to semicolon (;). One of: `Semicolon`, `Comma`.
- Decimal separator (`decimal_separator`, text): The decimal separator to use in the csv export. Defaults to dot (.). One of: `Comma`, `Dot`.
- Encoding (`encoding`, text): encoding. One of: `Utf8WithBom`, `Utf8WithoutBom`.

**Outputs**

- `data` (text): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": "example",
  "has_more": false,
  "next_cursor": null
}
```

### Export metric

Export metric.

**Inputs**

- Metric ID (`metric_id`, text, required): The ID of the metric to export
- Scenarios (`scenarios`, list): IDs of scenarios to be exported. If null or empty, only the default scenario will be exported and the export won"t have a scenario column.
- Filters (`filters`, list): Deprecated - use the ExportFilter field instead. If both this and ExportFilter are not null, they are combined with an implicit AND. Empty filters are treated as including all values.
- Export filter (`export_filter`, object): Additional structured export filter. Use the documented fields.
- Friendly headers (`friendly_headers`, true/false): If true, the exported CSV header will display metric friendly names. If null or not provided, it will display technical names.
- Date format (`date_format`, text): Defines how Date values in the response should be formatted. Usage of the 'Legacy' option is not recommended, the format will either be '01/21/2054', in other cases '10/12/2024 00:00:00 +00:00'. 'Iso8601' will format dates like '2054-01-21'. One of: `Legacy`, `Iso8601`.
- Field delimiter (`field_delimiter`, text): The field delimiter to use in the csv export. Defaults to semicolon (;). One of: `Semicolon`, `Comma`.
- Decimal separator (`decimal_separator`, text): The decimal separator to use in the csv export. Defaults to dot (.). One of: `Comma`, `Dot`.
- Encoding (`encoding`, text): encoding. One of: `Utf8WithBom`, `Utf8WithoutBom`.

**Outputs**

- `data` (text): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": "example",
  "has_more": false,
  "next_cursor": null
}
```

### Export table

Export table.

**Inputs**

- Table ID (`table_id`, text, required): The ID of the table to export
- Metrics (`metrics`, list): metrics.
- Scenarios (`scenarios`, list): IDs of scenarios to be exported. If null or empty, only the default scenario will be exported and the export won't have a scenario column.
- Filters (`filters`, list): Deprecated - use the ExportFilter field instead. If both this and ExportFilter are not null, they are combined with an implicit AND. Empty filters are treated as including all values.
- Export filter (`export_filter`, object): Additional structured export filter. Use the documented fields.
- Friendly headers (`friendly_headers`, true/false): If true, the exported CSV header will display metric friendly names. If null or not provided, it will display technical names.
- Date format (`date_format`, text): Defines how Date values in the response should be formatted. Usage of the 'Legacy' option is not recommended, the format will either be '01/21/2054', in other cases '10/12/2024 00:00:00 +00:00'. 'Iso8601' will format dates like '2054-01-21'. One of: `Legacy`, `Iso8601`.
- Field delimiter (`field_delimiter`, text): The field delimiter to use in the csv export. Defaults to semicolon (;). One of: `Semicolon`, `Comma`.
- Decimal separator (`decimal_separator`, text): The decimal separator to use in the csv export. Defaults to dot (.). One of: `Comma`, `Dot`.
- Fields (`fields`, list): List of fields to be included in the output csv, each as a single column. When not provided, one column for each metric and one column for each metric dimension is generated, in a fixed order.
- Encoding (`encoding`, text): encoding. One of: `Utf8WithBom`, `Utf8WithoutBom`.

**Outputs**

- `data` (text): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": "example",
  "has_more": false,
  "next_cursor": null
}
```

### Export view

Export view. Returns the full service response for the connected account.

**Inputs**

- View (`view_id`, text, required): The ID of the view to export
- Field delimiter (`field_delimiter`, text): The field delimiter to use in csv exports. Defaults to semicolon (;). One of: `Semicolon`, `Comma`.

**Outputs**

- `data` (text): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": "example",
  "has_more": false,
  "next_cursor": null
}
```

### Get data flow status

Get data flow status. Returns the full service response for the connected account.

**Inputs**

- Data flow execution ID (`data_flow_execution_id`, text, required): The execution ID returned by the trigger Data Flow endpoint

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "completedAt": "example",
    "createdAt": "example",
    "dataFlowExecutionId": "example",
    "dataFlowId": "example",
    "status": "InProgress",
    "steps": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get import status

Get import status. Returns the full service response for the connected account.

**Inputs**

- Import (`import_id`, text, required): The ID of the import, list data copy or metric data copy pipeline
- Included detailed report (`included_detailed_report`, true/false): Include detailed report with summary statistics (inserted, updated, deleted, skipped counts) and block type information. Defaults to false for performance reasons.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "completedAt": "example",
    "createdAt": "example",
    "detailedReport": {
      "autoCreatedDimensionModalities": [],
      "blockType": "Metric",
      "impactedBlocks": [],
      "summary": {
        "deletedCount": 1,
        "insertedCount": 1,
        "skippedCount": 1,
        "updatedCount": 1
      }
    },
    "errorsDetails": [],
    "importId": "example",
    "importStatus": "InProgress"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List application snapshots

List application snapshots. Returns the full service response for the connected account.

**Inputs**: None.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List applications

List applications. Returns the full service response for the connected account.

**Inputs**: None.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List blocks

List blocks. Returns the full service response for the connected account.

**Inputs**

- Application (`application_id`, text): The ID of the application ID to retrieve from.Í

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List data flows

List data flows. Returns the full service response for the connected account.

**Inputs**

- Application (`application_id`, text, required): The application whose Data Flows are listed

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List files

List files. Gets one page; to see more, run it again with the next page it gives.

**Inputs**

- Application (`application_id`, text, required): The ID of the application to list files from.
- Cursor (`cursor`, text): The cursor used to retrieve the next page of file metadata.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "hasMore": false,
    "items": [],
    "nextCursor": null
  },
  "has_more": false,
  "next_cursor": null
}
```

### List import configurations

List import configurations. Returns the full service response for the connected account.

**Inputs**

- Application (`application_id`, text): applicationId.
- Block (`block_id`, text): blockId.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List views

List views. Returns the full service response for the connected account.

**Inputs**

- Application (`application_id`, text): applicationId.
- Block (`block_id`, text): blockId.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### Run data flow

Run data flow.

**Inputs**

- Data flow ID (`data_flow_id`, text, required): The unique identifier of the Data Flow to trigger

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "dataFlowExecutionId": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Run import

Run import.

**Inputs**

- Configuration (`configuration_id`, text, required): The unique identifier of the import configuration to trigger

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "importId": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```
