API - DataCollector - Process execute

This documentation is only valid for the API version of a DataColllector execute.

Parrameters

To know the parameters necessary for the request, simply query the dataCollectorParrameters listing with the appropriate query string :

/open-api/v3/dataanalysis_datacollectorparameters?dataCollector={id}

Endpoint

It’s a simple GET operation, which returns all you need to know about the process.

Explample with “ :


"hydra:member": [
        {
            "@id": "/open-api/v3/dataanalysis_datacollectorparameters/5",
            "@type": "dataanalysis_datacollectorparameters",
            "name": "invoice_number",
            "defaultValue": "1",
            "type": "number",
            "dataCollector": {
                [...]
            },
            "shortcode": "DCP",
            "id": 5,
            "slug": "I-PosF_COUNT_invoice_number",
            "customProperties": null,
            "createdAt": "2023-10-24T20:53:24-04:00",
            "updatedAt": "2023-10-24T20:53:24-04:00",
            "toString": "invoice_number DCP5",
            "filterValue": 5,
            "uniqueId": "DCP5",
            "customDataList": "/open-api/v3/custom_properties?tableName=data_collectors_parameters",
            "customPropertiesListing": "/open-api/v3/custom_properties?tableName=data_collectors_parameters",
            "timestamp": "2023-10-24T20:53:24-04:00",
            "taggingListing": "/open-api/v3/taggings?resourceType=data_collectors_parameters&resourceId=5",
            "enabled": true,
            "disabled": false
        }
    ],

Using the OLD GET method with queryStrings [DEPRICATED]

GET example : ?invoice_number=3

Using the NEW POST method with standard body

POST example :


{
  "params": {
     "invoice_number": 3
  }
}

Endpoint

This is the process endpoint:

POST : /dataanalysis_datacollectors/{id}/execute

Body :


{
  "params": {
     "param1": "value1",
     "param2": "value2",
     [...]
  }
}

Example of response:


{
    "@context": {
        "@vocab": "https://demo1.cdk-ecs-dev.phpreaction.com/open-api/v3/docs.jsonld#",
        "hydra": "http://www.w3.org/ns/hydra/core#",
        "result": "ProcessOutput/result"
    },
    "@type": "ProcessOutput",
    "@id": "/open-api/v3/.well-known/genid/f85515479420c672cede",
    "result": [
        {
            "date_Y-m": "2026-08",
            "count": 6
        }
    ]
}