Jump to

• Request
• Response

Get the collection asset and its evalauted results by ID

get

/resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items

The resource endpoint returns the evalauted results in aggregated form for a given collection asset belonging to a given site name.

Important Note: It is a Collection Resource. All the evaluated results for the given collection asset are available in an items array in response. Each result is again an aggregated asset. So all the aggregate asset query params (assetDepth, expand, fields, segments, profileName) are also applicable to this resource. These aggregate asset query params are applied to each result in the items array. To know more about an aggregate asset and its query params, refer to Asset Resource end point.

Request

Path Parameters

• assetId: integer(double)
  ID of the collection asset
• collectionAssetType: string
  Name of the collection asset type
• siteName: string
  Name of the site

Query Parameters

• assetDepth: number
  To know about this parameter, refer to the 'assetDepth' query param in Asset Resource end point. Applicable to each result in the items array.
• expand: string
  Accepts a comma-separated list of assetTypes. To know more about this parameter, refer to the 'expand' query param in Asset Resource end point. Applicable to each result in the items array.
• fields: string
  To know about this parameter, refer to the 'fields' query param in Asset Resource end point. Applicable to each result in the items array.
• limit: number
  Specify the total number of items to be returned.
• links: string
  Accepts a comma-separated list of link names. By default, this parameter gives all the links (next, prev, first, last, schema, self, and canonical resources).
• offset: number
  Specify the starting index from where the results will be returned.
• profileName: string
  To know about this parameter, refer to the 'profileName' query param in Asset Resource. Applicable to each result in the items array.
• segments: string
  To know about this refer to the 'segments' query param in Asset Resource. Applicable to each result in the items array.
• totalResults: boolean
  Accepts a Boolean value. Setting it to true displays the total results field in the response. The default is false.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Collection asset results in aggregated format.

Back to Top