Export Datamart

post/datamart.export/{fcTypedIdOrSourceName}

Exports the specified Datamart source. Typically used in an integration scenario (IM) for a given customer. The request’s body can contain a data block with a regular filter criteria definition (as, for example, used in the JSON API fetch commands), to filter the output rows.

If the Analytics database for the parition is hosted in AWS, the export file(s) will be transferred to the corresponding S3 bucket, ready for retrieval using the datamart.fetchexportfile (Get a DM Export File) endpoint. Otherwise the files are put in the local file system of the node that handles the request:

default path: server/temp/<node>/export/<partition>/

If needed, a different, absolute path can be set using an instance parameter:

datamart.database.export.path

Data is exported in the CSV format, and is always gzip-compressed. Character encoding is always UTF-8. There is no client side encryption.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
fcTypedIdOrSourceName
required
string

Restricts the export to a specific source, identified by either the 'typedId' or 'sourceName'.

Example: DMDS.SegmentPrices
query Parameters
suffix
string

A suffix appended to the standard output file name: <typeCode>_<sourceUniqueName>_<suffix>.csv.gz

maxRows
string

The maximum number of returned rows.

Request Body schema: application/json
object
Array of objects non-empty unique
Array (non-empty)
operator
string non-empty
fieldName
string non-empty
value
string non-empty
operator
string non-empty
Responses
200

OK

Response Schema: application/json
object
node
string non-empty
Array of objects non-empty unique
Array (non-empty)
actionUUID
Array of objects

Use this in the datamart.getactionstatus/{actionUUID} endpoint to retrieve a file path of the exported file.

status
number
Request samples
application/json
{
  • "data": {
    • "criteria": [
      • {
        • "operator": "string",
        • "fieldName": "string",
        • "value": "string"
        }
      ],
    • "operator": "string"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "actionUUID": [
          ]
        }
      ],
    • "status": 0
    }
}