Pricefx REST API Reference
Pricefx REST API
/Pricefx API Reference/- Delete a Data Manager Entity
List Data Manager Entities
Execute a Data Load Logic
Get a DM Object
Get a DM Object
Get a DM Object (no count)
Update a Data Manager Entity
Create a Data Manager Entity
Upload a Bulk Data to Data Source
Run a Data Load
Save a Data Load
Mass Edit
List Data Loads (with validation and schedules)
List Data Loads
Query a Data Manager Object
SQL Query a Data Manager Object
List Rollups
List Charts
Import a Data Load
Export an Excel File (XLSX)
Export a CSV File
Get a DM Export File
Get Action Status
Export Datamart
Restore Default Data Sources
Import a File
Create a DMFieldCollection
List Datamart Orphan Objects
Delete Datamart Orphan Objects
Delete a Data Manager Ent...
The Pricefx Backend API
Download OpenAPI description
Overview
URL
Pricefx
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}
Request
Returns a list of Data Load definitions. No validation is run on returned Data Loads and no schedules are loaded. Use this endpoint for listing only.
If you need Data Loads to be validated and schedules returned, use the List Data Loads (with validation and schedules) (/datamart.getdataloads) endpoint instead.
Security
basic or X-PriceFx-jwt
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.listdataloads
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.listdataloads
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.listdataloadsResponse
application/json
{ "response": { "node": "string", "csrfToken": "string", "data": [ … ], "endRow": 0, "status": 0 } }
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.deletefc/{TypeCode}
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.deletefc/{TypeCode}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.deletefc/DMDS \
-H 'Content-Type: application/json' \
-d '{
"data": {
"uniqueName": "Transactions"
}
}'Response
application/json
{ "response": { "node": "string", "data": null, "status": 0 } }
Query
Bodyapplication/jsonSet this parameter to override the default timeout (60 seconds) of the query. The maximum allowed timeout is 300 seconds. The default timeout value and the maximum timeout value can be configured in the backend. Setting higher timeout can be useful, for example, when a query takes long time (e.g., when processing large tables).
Default "60"
Example: timeout=20
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.query
- URL:https://companynode.pricefx.com/pricefx/companypartition/datamart.query
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/datamart.query?timeout=20' \
-H 'Content-Type: application/json' \
-d '{
"operationType": "fetch",
"startRow": 0,
"endRow": 100000,
"sortBy": [],
"textMatchStyle": "exact",
"data": {
"query": {
"name": null,
"datamart": "DM.TransactionsDM",
"label": "Series1",
"source": "DM.TransactionsDM",
"projections": {
"bandBy": {
"alias": "bandBy",
"expression": "CustomerID",
"function": "",
"parameters": {},
"name": "CustomerID",
"label": "CustomerID"
},
"bubbleSize": {
"alias": "bubbleSize",
"expression": "SUM({field})",
"function": null,
"parameters": {
"field": "Quantity",
"quantity": "Quantity",
"base": "ListPrice"
},
"name": "Quantity",
"label": "∑Quantity",
"default": null,
"advancedProjection": true,
"formatString": "∑{field}"
},
"bubbleSize_n": {
"alias": "bubbleSize_n",
"expression": "SUM({field})",
"function": null,
"parameters": {
"field": "Quantity",
"quantity": "Quantity",
"base": "ListPrice"
},
"name": "Quantity",
"label": "∑Quantity (norm)",
"default": null,
"advancedProjection": true,
"formatString": "∑{field}"
},
"groupBy": {
"alias": "groupBy",
"expression": "Region",
"function": "",
"parameters": {},
"name": "Region",
"label": "Region"
},
"x": {
"alias": "x",
"expression": "SUM({field})",
"function": null,
"parameters": {
"field": "BasePrice",
"quantity": "Quantity",
"base": "ListPrice"
},
"name": "BasePrice",
"label": "∑BasePrice",
"default": null,
"advancedProjection": true,
"formatString": "∑{field}"
},
"y": {
"alias": "y",
"expression": "SUM({field})/SUM({quantity})",
"function": null,
"parameters": {
"field": "ListPrice",
"quantity": "Quantity",
"base": "ListPrice"
},
"name": "ListPrice",
"label": "∑ListPrice/∑Quantity",
"default": null,
"advancedProjection": true,
"formatString": "∑{field}/∑{quantity}"
}
},
"options": {
"currency": "EUR",
"regression": [
"y",
"x"
],
"distribution": [
"m1",
"x",
"y"
],
"normalization": [
"bubbleSize_n"
]
},
"filter": {
"criteria": [],
"operator": "and",
"_constructor": "AdvancedCriteria"
},
"aggregateFilter": null,
"dimensionFilters": [],
"limit": null,
"rollup": true,
"sortBy": []
}
},
"oldValues": null
}'Response
application/json
{ "response": { "node": "e2e-staging-node", "startRow": 0, "data": [ … ], "endRow": 3, "totalRows": 3, "status": 0 } }
CommentsCopy for LLM Copy page as Markdown for LLMs View as Markdown Open this page as Markdown Open in ChatGPT Get insights from ChatGPT Open in Claude Get insights from Claude Connect to Cursor Install MCP server on Cursor Connect to VS Code Install MCP server on VS Code