Subscriptions

Get environments render information included in the subscription.

All environments under that subscription are returned in the specific order by the environment type (Production, Sandbox, Development) and then by the descending order based on renders amount.

get/api/v1/subscriptions/{subscriptionId}/renders

Request

  • Base URL: https://api.chiligrafx.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.chiligrafx.com/api/v1/subscriptions/{subscriptionId}/renders
  • Auth: HTTP bearer

Path parameters

subscriptionIdstring uuid required

Subscription Id.

Query parameters

groupBystring required

Groups render information. For year returns renders for last 12 months and groups renders by each month. For month returns renders for last 30 days and groups renders by each day. These ranges can be overwritten by providing both startDate and endDate parameters.

topinteger

When top parameter is provided, the information for the top number of environments with higher number of renders is returned and for all the rest of existing environments in the subscription the renders are concatenated under "Others".

startDatestring

Start date of the range from which to return the renders. Required if endDate is provided. Format: yyyy-MM-dd.

endDatestring

End date of the range from which to return the renders. Required if startDate is provided. Format: yyyy-MM-dd.

Response

Returns array of environments render details.

datestring date-time required

Renders of environments date.

totalRendersinteger required

Total count of renders for environments.

totalWatermarkedRendersinteger required

Total count of renders (watermarked) for environments.

Example response

[
  {
    "date": "2021-11-01T00:00:00",
    "totalRenders": 4680,
    "totalWatermarkedRenders": 4680,
    "environments": [
      {
        "name": "cp-itm-000",
        "renders": 4680,
        "watermarkedRenders": 4680
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.