Create Aggregation Data Refinery

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.zerionsoftware.com/doc/dataflow-automation/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Dataflow Automation MCP server": {
    "url": "https://apidocs.zerionsoftware.com/doc/dataflow-automation/mcp"
  }
}

Close
POST /dataflows/{dataflowId}/recordsets/{recordSetId}/datarefinery

Create Aggregation Data Refinery.

Path parameters

  • dataflowId string Required

    id of the Dataflow

  • recordSetId string Required

    id of the RecordSet

application/json

Body

  • parameters object
    Hide parameters attributes Show parameters attributes object
    • aggregation_expression string
    • aggregation_helper_code string
    • filter_expression string
    • filter_helper_code string
    • group_by_expression string
    • preview_input_data string

      Preview data

  • delete_on_each_run boolean

    Currently not used

  • entity_id string

    id of the Entity

  • status number

    Currently not used

  • type_aggregation string

    Data Refinery type (PREPROCESSING or AGGREGATION)

POST /dataflows/{dataflowId}/recordsets/{recordSetId}/datarefinery
curl \
 --request POST 'https://dataflownode.zerionsoftware.com/zcrypt/v1.0/dataflows/{dataflowId}/recordsets/{recordSetId}/datarefinery' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"parameters\": {\n    \"aggregationExpression\": {\n      \"Test\": {\n        \"fields\": [\n          \"model\"\n        ],\n        \"map\": \"gnosiz.count.map\",\n        \"reduce\": \"gnosiz.count.reduce\"\n      }\n    },\n    \"aggregationHelperCode\": \"\",\n    \"filterExpression\": \"\",\n    \"filterHelperCode\": \"\",\n    \"groupByExpression\": \"o.make\",\n    \"previewInputData\": {\n      \"CREATED_BY\": \"gnosiz\",\n      \"CREATED_DATE\": \"2015-07-01 10:26:47 +0000\",\n      \"CREATED_DEVICE_ID\": \"Server\",\n      \"CREATED_LOCATION\": \"Server\",\n      \"ID\": \"9\",\n      \"MODIFIED_BY\": \"gnosiz\",\n      \"MODIFIED_DATE\": \"2015-07-01 10:26:47 +0000\",\n      \"MODIFIED_DEVICE_ID\": \"Server\",\n      \"MODIFIED_LOCATION\": \"Server\",\n      \"PAGE_ID\": \"290759158\",\n      \"PARENT_ELEMENT_ID\": \"0\",\n      \"PARENT_PAGE_ID\": \"0\",\n      \"PARENT_RECORD_ID\": \"0\",\n      \"PROFILE_ID\": \"10845\",\n      \"SERVER_MODIFIED_DATE\": \"2015-07-01 10:26:47 +0000\",\n      \"color\": \"Soul Red\",\n      \"make\": \"Mazda\",\n      \"model\": \"Miata\",\n      \"year\": \"2016\"\n    }\n  },\n  \"deleteOnEachRun\": true,\n  \"entityId\": \"5684058f159fffbe29ff9912\",\n  \"status\": null,\n  \"type\": \"AGGREGATION\"\n}"'
Request example
{
  "parameters": {
    "aggregationExpression": {
      "Test": {
        "fields": [
          "model"
        ],
        "map": "gnosiz.count.map",
        "reduce": "gnosiz.count.reduce"
      }
    },
    "aggregationHelperCode": "",
    "filterExpression": "",
    "filterHelperCode": "",
    "groupByExpression": "o.make",
    "previewInputData": {
      "CREATED_BY": "gnosiz",
      "CREATED_DATE": "2015-07-01 10:26:47 +0000",
      "CREATED_DEVICE_ID": "Server",
      "CREATED_LOCATION": "Server",
      "ID": "9",
      "MODIFIED_BY": "gnosiz",
      "MODIFIED_DATE": "2015-07-01 10:26:47 +0000",
      "MODIFIED_DEVICE_ID": "Server",
      "MODIFIED_LOCATION": "Server",
      "PAGE_ID": "290759158",
      "PARENT_ELEMENT_ID": "0",
      "PARENT_PAGE_ID": "0",
      "PARENT_RECORD_ID": "0",
      "PROFILE_ID": "10845",
      "SERVER_MODIFIED_DATE": "2015-07-01 10:26:47 +0000",
      "color": "Soul Red",
      "make": "Mazda",
      "model": "Miata",
      "year": "2016"
    }
  },
  "deleteOnEachRun": true,
  "entityId": "5684058f159fffbe29ff9912",
  "status": null,
  "type": "AGGREGATION"
}