GoSmarter API Gateway
string · uuid · requiredstring · uuid · requiredstring · date-timestring · date-timestringstringstringstring · uuidstring · uuid
string · uuid · requiredstring · uuid · requiredstringstring · date-timestring · date-timestringstringstringstring · uuidstring · uuid
string · uuid · requiredstring · uuidstring · uuidinteger · int32string · date-timestring · date-timestring · uuidstringstring · date-timestring · date-timeinteger · int32
Get optimisation result (slim)
GET
https://api.gosmarter.ai
/api/company/{companyId}/optimisation-slim/{resultId}
Retrieves a single optimisation result for the specified company and result ID.
path Parameters
companyIdThe company GUID.
resultIdThe optimisation result GUID.
Get optimisation result (slim) › Responses
The optimisation result item.
dateCreateddateUpdatedresultresultComparisondescriptionresultIdcompanyIdDownload optimisation result
GET
https://api.gosmarter.ai
/api/company/{companyId}/optimisation-slim/{resultId}/download
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'.
Download optimisation result › Responses
The optimisation result file.
dateCreateddateUpdatedresultresultComparisondescriptionresultIdcompanyIdList optimisation results
GET
https://api.gosmarter.ai
/api/company/{companyId}/optimisation-slim
Lists all optimisation request triggers and associated results for the specified company.
path Parameters
companyIdThe company GUID.
List optimisation results › Responses
200
List of optimisation request triggers with results.
object[]
optimisationRequestTriggerIdcompanyIdstatustriggerCreatedAttriggerUpdatedAtresultIddescriptionresultCreatedAtresultUpdatedAtresultCountStart optimisation
POST
https://api.gosmarter.ai
/api/company/{companyId}/optimisation-slim/start