GoSmarter Logo
GoSmarter API Gateway
GoSmarter API Gateway

Insights

Get customer order trends

GET
https://api.gosmarter.ai
/api/company/{companyId}/insights/customer-trends

Compares each customer's order value/count in the last windowDays (default 90) against the prior windowDays. Sorted by percent change ascending — biggest decline first.

Get customer order trends › path Parameters

companyId
​string · uuid · required

The company to query. Example: 11111111-2222-3333-4444-555555555555

Get customer order trends › query Parameters

windowDays
​integer · int32

Rolling window size in days, compared against the same-length prior window. Default 90.

Get customer order trends › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get customer order trends › Responses

Customer trend rows, worst decline first

customerTrendDto
relatedOrganisationId
​string · uuid
customerName
​string
currentPeriodValue
​number · double
currentPeriodOrderCount
​integer · int32
priorPeriodValue
​number · double
priorPeriodOrderCount
​integer · int32
percentChange
​number · double

Get insights summary for a single customer organisation

GET
https://api.gosmarter.ai
/api/company/{companyId}/organisations/{organisationId}/insights/summary

Bundles product mix and order trend for one customer — backs the per-organisation drill-down view.

Get insights summary for a single customer organisation › path Parameters

companyId
​string · uuid · required

The company to query. Example: 11111111-2222-3333-4444-555555555555

organisationId
​string · uuid · required

The customer organisation to summarize

Get insights summary for a single customer organisation › query Parameters

windowDays
​integer · int32

Rolling window size in days for the trend comparison. Default 90.

Get insights summary for a single customer organisation › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get insights summary for a single customer organisation › Responses

Organisation insights summary

organisationInsightsSummaryDto
relatedOrganisationId
​string · uuid
customerName
​string
​productMixItemDto[]

Get product mix by customer

GET
https://api.gosmarter.ai
/api/company/{companyId}/insights/product-mix

Returns aggregated order quantity/value grouped by customer, material, type and grade. Filter to a single customer with organisationId.

Get product mix by customer › path Parameters

companyId
​string · uuid · required

The company to query. Example: 11111111-2222-3333-4444-555555555555

Get product mix by customer › query Parameters

organisationId
​string · uuid

Optional: filter to a single customer organisation

Get product mix by customer › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get product mix by customer › Responses

Product mix rows, highest value first

productMixItemDto
relatedOrganisationId
​string · uuid
customerName
​string
materialId
​integer · int32
materialName
​string
typeId
​integer · int32
typeName
​string
metalGradeId
​integer · int32
gradeName
​string
totalQuantity
​integer · int32
totalValue
​number · double
orderCount
​integer · int32

Get slow-moving stock

GET
https://api.gosmarter.ai
/api/company/{companyId}/insights/slow-moving-stock

Returns inventory items with no linked order activity in the given threshold window (default 90 days), oldest/most-stale first.

Get slow-moving stock › path Parameters

companyId
​string · uuid · required

The company to query. Example: 11111111-2222-3333-4444-555555555555

Get slow-moving stock › query Parameters

thresholdDays
​integer · int32

Minimum days since last movement to be considered slow-moving. Default 90.

Get slow-moving stock › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get slow-moving stock › Responses

Slow-moving stock rows

slowMovingStockItemDto
inventoryId
​string · uuid
companyId
​string · uuid
productName
​string
productReference
​string
quantity
​integer · int32
weight
​number · double
unitPrice
​number · double
heatCode
​string
supplierId
​string · uuid
supplierName
​string
receivedAt
​string · date-time
daysSinceReceived
​integer · int32
lastOrderDate
​string · date-time
daysSinceLastMovement
​integer · int32
ScrapLogDashboardCharts