Pigment

App · 15 actions

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

Actions

ActionWhat it does
Export listExport list.
Export metricExport metric.
Export tableExport table.
Export viewExport view.
Get data flow statusGet data flow status.
Get import statusGet import status.
List application snapshotsList application snapshots.
List applicationsList applications.
List blocksList blocks.
List data flowsList data flows.
List filesList files.
List import configurationsList import configurations.
List viewsList views.
Run data flowRun data flow.
Run importRun import.

Export list

Export list.

Inputs

Listlist_idtextRequired
The ID of the list to export
Property technical namesproperty_technical_nameslist
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 filterlist_filterlist
List of modalities of the list to filter in. Empty or null means all.
Property filtersproperty_filterslist
List of property filters.
Friendly headersfriendly_headerstrue/false
If true, the exported CSV header will display list and properties friendly names. If null or false, it will display technical names.
Date formatdate_formattext
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 delimiterfield_delimitertext
Field separator, defaults to semicolon (;)One of: Semicolon, Comma.
Decimal separatordecimal_separatortext
The decimal separator to use in the csv export. Defaults to dot (.).One of: Comma, Dot.
Encodingencodingtext
encoding.One of: Utf8WithBom, Utf8WithoutBom.

Outputs

datatext
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": "example",
  "has_more": false,
  "next_cursor": null
}

Export metric

Export metric.

Inputs

Metric IDmetric_idtextRequired
The ID of the metric to export
Scenariosscenarioslist
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.
Filtersfilterslist
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 filterexport_filterobject
Additional structured export filter. Use the documented fields.
Friendly headersfriendly_headerstrue/false
If true, the exported CSV header will display metric friendly names. If null or not provided, it will display technical names.
Date formatdate_formattext
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 delimiterfield_delimitertext
The field delimiter to use in the csv export. Defaults to semicolon (;).One of: Semicolon, Comma.
Decimal separatordecimal_separatortext
The decimal separator to use in the csv export. Defaults to dot (.).One of: Comma, Dot.
Encodingencodingtext
encoding.One of: Utf8WithBom, Utf8WithoutBom.

Outputs

datatext
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": "example",
  "has_more": false,
  "next_cursor": null
}

Export table

Export table.

Inputs

Table IDtable_idtextRequired
The ID of the table to export
Metricsmetricslist
metrics.
Scenariosscenarioslist
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.
Filtersfilterslist
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 filterexport_filterobject
Additional structured export filter. Use the documented fields.
Friendly headersfriendly_headerstrue/false
If true, the exported CSV header will display metric friendly names. If null or not provided, it will display technical names.
Date formatdate_formattext
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 delimiterfield_delimitertext
The field delimiter to use in the csv export. Defaults to semicolon (;).One of: Semicolon, Comma.
Decimal separatordecimal_separatortext
The decimal separator to use in the csv export. Defaults to dot (.).One of: Comma, Dot.
Fieldsfieldslist
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.
Encodingencodingtext
encoding.One of: Utf8WithBom, Utf8WithoutBom.

Outputs

datatext
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": "example",
  "has_more": false,
  "next_cursor": null
}

Export view

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

Inputs

Viewview_idtextRequired
The ID of the view to export
Field delimiterfield_delimitertext
The field delimiter to use in csv exports. Defaults to semicolon (;).One of: Semicolon, Comma.

Outputs

datatext
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "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 IDdata_flow_execution_idtextRequired
The execution ID returned by the trigger Data Flow endpoint

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "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

Importimport_idtextRequired
The ID of the import, list data copy or metric data copy pipeline
Included detailed reportincluded_detailed_reporttrue/false
Include detailed report with summary statistics (inserted, updated, deleted, skipped counts) and block type information. Defaults to false for performance reasons.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "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

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List applications

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

Inputs

None.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List blocks

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

Inputs

Applicationapplication_idtext
The ID of the application ID to retrieve from.Í

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List data flows

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

Inputs

Applicationapplication_idtextRequired
The application whose Data Flows are listed

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "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

Applicationapplication_idtextRequired
The ID of the application to list files from.
Cursorcursortext
The cursor used to retrieve the next page of file metadata.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "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

Applicationapplication_idtext
applicationId.
Blockblock_idtext
blockId.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

List views

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

Inputs

Applicationapplication_idtext
applicationId.
Blockblock_idtext
blockId.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Run data flow

Run data flow.

Inputs

Data flow IDdata_flow_idtextRequired
The unique identifier of the Data Flow to trigger

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "dataFlowExecutionId": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Run import

Run import.

Inputs

Configurationconfiguration_idtextRequired
The unique identifier of the import configuration to trigger

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "importId": "example"
  },
  "has_more": false,
  "next_cursor": null
}

On this page