Document toolboxDocument toolbox

Working with the Aggregation task API

Owned by Anthony Shevlin (Deactivated)
Last updated: Dec 19, 2023 by Borja Moro Moreno
12 min read
[ 1 Overview ] [ 2 Endpoints and methods ]

Overview

Check the list of available endpoints and methods in the Aggregation task API:

Endpoints and methods

Description

Endpoints and methods

Description

GET /aggrtasks/{domain} see below

Get information about all the aggregation tasks in a domain.

GET /aggrtasks/{domain}/{aggrId} see below

Get information about a specific aggregation task.

GET /aggrtasks/{domain}/{aggrId}/measures see below

Get the measures of an aggregation task.

POST /aggrtasks/{domain} see below

Create a new aggregation task.

PUT /aggrtasks/{domain}/{aggrId} see below

Update an aggregation task.

PUT /aggrtasks/{domain}/{aggrId}/stop see below

Stop an aggregation task.

PUT /aggrtasks/{domain}/{aggrId}/start see below

Start a task and add aggregated data from a specific date.

PUT /aggrtasks/{domain}/{aggrId}/resume see below

Resume a stopped aggregation task.

DELETe /aggrtasks/{domain}/{aggrId} see below

Delete an aggregation task.

Endpoints and methods

GET /aggrtasks/{domain}

Get information about all the aggregation tasks in a domain.

To perform this request, your Devo user must have at least the Aggregation tasks (view) permission assigned. Learn more about roles and permissions in Role permissions.

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

Parameter

Type

Description

domain required

string

Enter the domain of the aggregation tasks you want to get information about.

Query string parameters

Query string parameters are optionally added after the path parameters, preceded by a question mark (?) and separated by an ampersand (&)

Parameter

Type

Description

Parameter

Type

Description

skipCache

boolean

If it is true, skips the cache that contains the status of the aggregation tasks and force the system to tell you where to find them.

Default value is false.

status

string

Execution status of the aggregation tasks. Available values are:

  • RUNNING

  • STOPPED

  • DELETED

  • ERROR

  • PARTIAL_STOPPED

  • PENDING_CREATE

  • PENDING_START

  • PENDING_STOP

  • PENDING_UPDATE

  • PENDING_REBUILD

  • PENDING_DELETE

  • PENDING_RESUME

  • PENDING_EXTEND

id

string

If you want to get details about a specific aggregation task only, enter its ID here.

How can I get the ID of an aggregation task?

To get the ID of an aggregation task, log in to the Devo platform and go to Administration → Data management, locate your aggregation task in the table, click the ellipsis button in its row and select View details. You can copy the internal ID in the details shown in the window that appears.

Learn more about this in Aggregation tasks.

fromDate

integer

Timestamp from when the aggregation tasks to be returned were created. Format is a timestamp in milliseconds, for example 1652400000000

name

string

If you want to get details about a specific aggregation task only, you can enter its name.

ownerEmail

string

Email of the aggregation tasks' owner.

negated

boolean

Set this to true to negate all other parameters. Default value is false.

Example

Find below a request example in cURL language. In this case, we are requesting all the aggregation tasks with status STOPPED created in the given domain. Learn how to authorize your request in this article.

curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain?status=STOPPED"

Code

Description

Code

Description

200

Successful response. List of aggregation tasks retrieved.

[ { "id": "cc_myDomain:nQEbd480", "name": "test1", "delay": 0, "domainName": "myDomain", "ownerEmail": "john.smith@devo.com", "jobs": [ { "grain": "1m", "status": "STOPPED", "from": 1652400000000, "to": 1652432340000 }, { "grain": "5m", "status": "STOPPED", "from": 1652400000000, "to": 1652400000000 }, { "grain": "1h", "status": "STOPPED", "from": 1652400000000, "to": 1652400000000 } ], "creationDate": 1652432342000, "updateDate": 1652432342000, "status": "STOPPED", "statusData": "INCOMPLETE", "fromDate": 1652400000000 }, { "id": "cc_myDomain:oYckc691", "name": "test2", "delay": 0, "domainName": "myDomain", "ownerEmail": "john.smith@devo.com", "jobs": [ { "grain": "1m", "status": "STOPPED", "from": 1652400000000, "to": 1652436480000 }, { "grain": "5m", "status": "STOPPED", "from": 1652400000000, "to": 1652436300000 }, { "grain": "1h", "status": "STOPPED", "from": 1652400000000, "to": 1652436000000 } ], "creationDate": 1652436468000, "updateDate": 1652436468000, "status": "STOPPED", "statusData": "INCOMPLETE", "fromDate": 1652400000000 } ]

400

Error in request

401

Unauthorized error.

403

Forbidden request.

404

Not found.

405

Method not allowed.

500

Server error and Java exception.

GET /aggrtasks/{domain}/{aggrId}

Get information about a specific aggregation task in a given domain.

To perform this request, your Devo user must have at least the Aggregation tasks (view) permission assigned. Learn more about roles and permissions in Role permissions.

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Description

Parameter

Type

Description

domain required

string

Enter the domain of the aggregation task you want to get information about.

aggrId required

string

Enter the ID of the aggregation task you want to get information about.

Query string parameters

Query string parameters are optionally added after the path parameters, preceded by a question mark (?) and separated by an ampersand (&)

Parameter

Type

Description

Parameter

Type

Description

skipCache

boolean

If it is true, skips the cache that contains the status of the aggregation task and force the system to tell you where to find it.

Default value is false.

Example

Find below a request example in cURL language. In this case, we are requesting details about the aggregation task with ID cc_myDomain:abcDE123 created in the domain called myDomain. Also, we want to skip the cache about its status. Learn how to authorize your request in this article.

curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain/cc_myDomain:abcDE123?skipCache=true"

Code

Description

Code

Description

200

Successful response. aggregation task details retrieved.

400

Error in request

401

Unauthorized error.

403

Forbidden request.

404

Not found.

405

Method not allowed.

500

Server error and Java exception.

GET /aggrtasks/{domain}/{aggrId}/measures

Get the measures of an aggregation task.

Path parameters

Add the following path parameters as part of the endpoint:

Parameter

Type

Parameter

Parameter

Type

Parameter

domain required

string

Enter the domain of the aggregation task you want to get information about.

aggrId required

string

Enter the ID of the aggregation task you want to get information about.

Example

Find below a request example in cURL language. In this case, we are requesting the measures of the aggregation task with ID cc_myDomain:abcDE123 created in the domain called myDomain. Also, we want to skip the cache about its status. Learn how to authorize your request in this article.

POST /aggrtasks/{domain}

Create a new aggregation task.

PUT /aggrtasks/{domain}/{aggrId}

Update a specific aggregation task.

PUT /aggrtasks/{domain}/{aggrId}/stop

Stop an aggregation task.

PUT /aggrtasks/{domain}/{aggrId}/start

Start a new task and add aggregated data from a specific date.

PUT /aggrtasks/{domain}/{aggrId}/resume

Resume an aggregation task from the date it was stopped.

DELETE /aggrtasks/{domain}/{aggrId}

Delete an aggregation task. This will permanently remove all the tasks and associated metadata.