Get optimisation result (slim)
Retrieves a single optimisation result for the specified company and result ID.
path Parameters
companyIdThe company GUID.
resultIdThe optimisation result GUID.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get optimisation result (slim) › Responses
The optimisation result item.
dateCreateddateUpdatedresultresultComparisondescriptionresultIdcompanyIdDownload optimisation result
Downloads the optimisation result as JSON or CSV/ZIP for the specified company and result ID.
path Parameters
companyIdThe company GUID.
resultIdThe optimisation result GUID.
query Parameters
formatDownload format: 'json' (default) or 'csv'.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Download optimisation result › Responses
The optimisation result file.
dateCreateddateUpdatedresultresultComparisondescriptionresultIdcompanyIdList optimisation results
Lists all optimisation request triggers and associated results for the specified company.
path Parameters
companyIdThe company GUID.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List optimisation results › Responses
List of optimisation request triggers with results.
optimisationRequestTriggerIdcompanyIdstatustriggerCreatedAttriggerUpdatedAtresultIddescriptionresultCreatedAtresultUpdatedAtresultCountDelete optimisation results
Deletes one or more optimisation results for the specified company.
path Parameters
companyIdThe company GUID.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Delete optimisation results › Responses
List of deleted result items.
Start optimisation
Triggers a new optimisation request for the specified company.
path Parameters
companyIdThe company GUID.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Start optimisation › Responses
The created optimisation request trigger.
optimisationRequestTriggerIdcompanyId