Fetch a Report Component

get https://helios.cohesity.com/heliosreporting/api/v1/public/components/{id}

Get information about a Report component.

Responses

Response body

object

string | null

Specifies the id of the Component.

name

string | null

Specifies the name of the Component.

description

string | null

Specifies description of the Component.

reportType

string | null

Specifies the report type on top of which this Component is created from.

ClusterConnections ClusterConnectionsTrend ProtectedUnprotectedObjects ProtectedObjects ProtectionActivity ProtectionGroupSummary ProtectionRuns ProtectionRunsTrend StorageConsumptionByObjects StorageConsumptionByProtectionGroups StorageConsumptionByClusters StorageConsumptionByStorageDomains StorageConsumptionByOrganizations StorageConsumptionByClustersTrend StorageConsumptionByViews ServiceConsumption ServiceConsumptionTrend Recovery Failures ProtectionSummaryBySystem DataTransferredToExternalTargets DataTransferredToExternalTargetsTrend

aggs

object

Specifies the aggregation related information that needs to be applied on the attributes.

groupedAttributes

array of strings

Specifies list of attributes to be grouped in the aggregation.

groupedAttributes

aggregatedAttributes

array of objects | null

Specifies list of aggregation properties to be applied on the attributes.

aggregatedAttributes

object

aggregationType

string | null

required

Specifies the aggregation type.

sum count min max avg countDistinct

attribute

string | null

required

Specifies the attribute name.

label

string | null

Specifies the label to be generated for this aggregated attribute. If not specified, then by default label of the column in the output will be combination of aggregation type and attribute

sort

array of objects | null

Specifies the sorting (ordering) parameters to be applied to the resulting data.

sort

object

attribute

string

required

Specifies the name of the attribute.

desc

boolean | null

Specifies whether the sorting order should be descending. Default value is false.

limit

object

Specifies the parameters to limit the resulting dataset.

from

integer | null

Specifies the offset to which resulting data will be skipped before applying the size parameter. For example if dataset size is 10 objects, from=2 and size=5, then from 10 objects only 5 objects are returned starting from offset 2 i.e., 2 to 7. If not specified, then none of the objects are skipped.

size

integer

required

≥ 1

Specifies the number of objects to be returned from the offset specified.

filters

array of objects | null

Specifies the filters that are applied on specific report type attributes in order to compose this component.

filters

object

attribute

string | null

required

Specifies the attribute.

filterType

string | null

required

Specifies the type of the filter that needs to be applied.

In Range TimeRange Systems Tenants

inFilterParams

object

Specifies the in filter that are applied on attributes.

rangeFilterParams

object

Specifies the filters that are applied on attributes.

timeRangeFilterParams

object

Specifies the time range filter. Specifying this will pre filter all the results on necessary resources like Protection Runs etc before applying aggregations. Currently, maximum allowed time range is 60 days.

systemsFilterParams

object

Specifies the systems filter. Specifying this will pre filter all the results provided list of system identifier before applying aggregations.

tenantsFilterParams

object

Specifies the tenants filter. Specifying this will pre filter all the
results with provided list of tenants before applying aggregations.

config

object

Specifies the configuration parameters to customize and format the columns in the report artifacts like excel, pdf etc

xlsxParams

object

Specifies the configuration parameters to customize a component in excel report.

data

array

Specifies the data returned after evaluating the component.

data

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://helios.cohesity.com/heliosreporting/api/v1/public/components/id \
3
     --header 'accept: */*'


xxxxxxxxxx
95
}
1
{
2
  "id": "string",
3
  "name": "string",
4
  "description": "string",
5
  "reportType": "ClusterConnections",
6
  "aggs": {
7
    "groupedAttributes": [
8
      "string"
9
    ],
10
    "aggregatedAttributes": [
11
      {
12
        "aggregationType": "sum",
13
        "attribute": "string",
14
        "label": "string"
15
      }
16
    ]
17
  },
18
  "sort": [
19
    {
20
      "attribute": "string",
21
      "desc": true
22
    }
23
  ],
24
  "limit": {

200Success

defaultError