Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the <code>GetSessionsStatisticsAggregation</code> operation. You can only have one running aggregation for your Deadline Cloud farm. Call the <code>GetSessionsStatisticsAggregation</code> operation and check the <code>status</code> field to see if an aggregation is running. Statistics are available for 1 hour after you call the <code>StartSessionsStatisticsAggregation</code> operation.

post/2023-10-12/farms/{farmId}/sessions-statistics-aggregation

Path parameters

farmIdstring required

The identifier of the farm that contains queues or fleets to return statistics for.

Request body

startTimestring date-time required

The Linux timestamp of the date and time that the statistics start.

endTimestring date-time required

The Linux timestamp of the date and time that the statistics end.

timezonestring

The timezone to use for the statistics. Use UTC notation such as "UTC+8."

period'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY'

The period to aggregate the statistics.

groupByUsageGroupByField[] required

The field to use to group the statistics.

statisticsUsageStatistic[] required

One to four statistics to return.

Response

Success

aggregationIdstring required

A unique identifier for the aggregated statistics. Use this identifier with the <code>GetAggregatedStatisticsForSessions</code> operation to return the statistics.