Generate report
Generates a report of a specified type given certain general conditions such as time range and other type-specific filters.
- application/json
Request Body required
- file_name string required
The name of the report. Field cannot be empty.
- filter string
Field Filter Condition Report Type Description activity_start_timestamp $gte, $lt, $eq Activity Activity start timestamp denotes the time filter for Activity reports. $gte and $lt accept RFC-3339 timestamps and $eq accepts a unix timestamp denoting the offset from the current time. $eq takes precedence over both $gte and $lt so if $eq is used, the backend will use the relative time filter instead of absolute time filters.For example, "filter":"{"activity_start_timestamp":{"$eq":86400}}"
timestamp $gte, $lte, $eq Consumption timestamp denotes the time filter for Consumption reports. $gte and $lte accept RFC-3339 timestamps and $eq accepts a duration in seconds denoting the offset from the current time. $eq takes precedence over both $gte and $lte so if $eq is used, the backend will use the relative time filter instead of absolute time filters. "filter": "{\"timestamp\":{\"$gte\":\"2022-07-27T14:35:33.735Z\",\"$lte\":\"2022-08-03T14:35:33.735Z\"}}"
organizational_unit_id $in Consumption Organizational Unit ID (OU ID) filters the consumption data generated for the report to the given OU IDs and its children. "filter": "{\"organizational_unit_id\":{\"$in\":[\"00000000-0000-0000-0000-000000000000\"]}}"
entity_type $in Consumption Entity type filters the consumption data generated for the report to the given entity types. If filter is empty, it shows consumption report of the all entity types. ?filter={"entity_type":{"$in":["LocalProtectionGroup, DynamoDB"]}}
task $in Activity Possible values for task include backup
andrestore
. For example,"filter":"{"task":{"$in":["ebs_incremental_backup"]}}"
status $in Activity Filter on activity status of entity. Possible values for activity status include aborted
,failed
, andsuccess
For example,"filter": "{"status":{"$in":["success"]}}"
primary_entity.id $in Any The system-generated IDs of the primary entities affected by the activity. For example, ?filter={"primary_entity.id":{"$in":["9c2934fc-ff4d-11e9-8e11-76706df7fe01"]}}
primary_entity.type $eq Any The type of primary entities affected by the activity. Examples of primary entity types include "aws_ebs_volume", "aws_ec2_instance", "microsoft365_mailbox". For example, ?filter={"primary_entity.type":{"$in":["aws_ebs_volume"]}}
primary_entity.value $in Any The value or name associated with the primary entities affected by the compliance event. For example, the primary entity value associated with primary entity type "aws_ebs_volume" is "vol-0a5f2e52d6decd664" representing the name of the EBS volume. The filter supports substring search for all elements in the array For example, ?filter={"primary_entity.value":{"$in":["vol-0a"]}}
parent_entity.type $in Any The types of the parent entities which are associated with the primary entity affected by the activity. Examples of the parent entity types include "aws_environment", "microsoft365_domain". For example, ?filter={"parent_entity.type":{"$in":["aws_environment"]}}
parent_entity.id $in Any The value or name associated with the parent entities affected by the compliance event. For example, the parent entity value associated with primary entity type "aws_ebs_volume" is "891106093485/us-west-2" representing the name of the AWS Account Region. For example, ?filter={"parent_entity.id":{"$in":["9c2934fc-ff4d-11e9-8e11-76706df7fe01"]}}
For more information about filtering, refer to the Filtering section of this guide. - type string required
Possible values: [
activity
,audit
,consumption
]The report type. Examples of report types include, "activity", "audit", and "consumption".
Responses
- 202
- default
Success
- application/api.clumio.report-downloads=v1+json
- Schema
- Example (from schema)
Schema
_links object
- task_id string
The Clumio-assigned ID of the task created by the request. The progress of the task can be monitored using the
GET /tasks/{task_id}
endpoint.
{
"_links": {
"_self": {
"href": "string",
"templated": true,
"type": "string"
},
"read-task": {
"href": "string",
"templated": true,
"type": "string"
}
},
"task_id": "string"
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
POST /reports/downloads
Authorization
Request
Request
curl -L -X POST 'https://us-west-2.api.clumio.com/reports/downloads' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.report-downloads=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"file_name": "string",
"filter": "string",
"type": "activity"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/reports/downloads' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.report-downloads=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"file_name": "string",
"filter": "string",
"type": "activity"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/reports/downloads' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.report-downloads=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"file_name": "string",
"filter": "string",
"type": "activity"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/reports/downloads' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.report-downloads=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"file_name": "string",
"filter": "string",
"type": "activity"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/reports/downloads' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.report-downloads=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"file_name": "string",
"filter": "string",
"type": "activity"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/reports/downloads' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.report-downloads=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"file_name": "string",
"filter": "string",
"type": "activity"
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/reports/downloads' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.report-downloads=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"file_name": "string",
"filter": "string",
"type": "activity"
}'