Skip to main content

Image Optimizer

GET Image Optimizer#

Gets distribution image optimizer usage data

GET ALL
MethodGET ALL
URL or EndPoint/api/v{version}/countries
HeadersAuthorization or X-API-Key
ParametersprojectId, version
BodyNot Applicable

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeExampleDescription
v{version}Yesstringv1Shows the version of API
{projectId}Yesstring($uuid)3fa85f64-5717-4562-b3fc-2c963f66afa6The project's ID. If the ID is empty, an empty distribution configuration is returned

The description of the parameters is as follows:

Parameter NameMandatoryTypeExampleDescription
versionYesstring1The api version
IntervalTypeNoint0, 1, 2, 3, 4, 5Enter interval type
TermCountNoint0Enter term count
DistributionIdsNostring($uuid)"string"Enter number of entities per page

Request Body#

The request does not have a request body.

Responses#

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in json format by the service.

{  "success": true,  "errors": [    "string"  ],  "messages": [    "string"  ],  "result": {    "totalOperations": 0,    "aggregatesPerInterval": [      {        "time": "2022-04-01T13:32:29.607Z",        "operations": 0      }    ]  },  "resultInfo": {    "totalCount": 0,    "pageIndex": 0,    "pageSize": 0,    "totalPages": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}
Field NameTypeExampleDescription
successbooltrueIf response is success will return true otherwise will get false
errorsstring"string"Indicate if there was an error
messagesstring"string"Returns the response message from back-end
resultarray [object]Returns an distribution object
totalOperationsinteger($int32)0Returns total operations
aggregatesPerIntervalarray [object]Returns an object of aggregates per interval
timeDateTime"2022-04-01T13:32:29.607Z"Returns time of the aggregate interval
operationsinteger($int32)0Returns the operations of the aggregate interval
resultInfoobjectReturs information about distribution
totalCountinteger($int32)0Total number of objects in database
pageIndexinteger($int32)0Returns Current pageop paganed data
pageSizeinteger($int32)0Returns Objects per page
totalPagesinteger($int32)0Returns Total pages
hasNextPagebooltrueReturns true if it has a next page, otherwise returns false
hasPreviousPagebooltrueReturns true if it has a previous page, otherwise returns false

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code: 401 Unauthorized
  • HTTP Status Code: 403 Forbidden
  • HTTP Status Code: 404 Not found