Environments

Get environment SaaS and Studio renders information.

get/api/v1/environments/{environmentId}/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/environments/{environmentId}/renders
  • Auth: HTTP bearer

Path parameters

environmentIdstring uuid required

Environment 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.

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 environment renders information.

datestring date-time required

Render date.

totalRendersinteger required

Total renders count.

totalWatermarkedRendersinteger required

Total renders (watermarked) count.

Example response

[
  {
    "date": "2021-11-01T00:00:00",
    "totalRenders": 2048,
    "totalWatermarkedRenders": 2048,
    "renderDetail": [
      {
        "name": "Pdf",
        "renders": 1024
      }
    ]
  }
]

Changes

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