Miridia
Portal
Insights

Network insights

The supply-chain network graph: supplier, location and sales-channel nodes, and the purchase-order, transfer-order and sales-order flows between them.

Base URL: https://api.miridia.io. Read Authentication and Conventions before you call these operations.

MethodPathOperation
GET/api/v1/insights/networkGet network insight

Get network insight

GET/api/v1/insights/network

Returns the network graph for the business over the period. Defaults to the current calendar month when from/to are not supplied.

Access. Send a bearer token or an API key. The caller needs the Insights view permission.

Parameters

NameInTypeRequiredDescription
fromquerystring (date-time)No
toquerystring (date-time)No

Response

200. Returns a SingleResult envelope. The data field is NetworkInsightResponse.

Request
curl -X GET "https://api.miridia.io/api/v1/insights/network" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"
Response
{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "periodFrom": "2026-09-29T08:00:00Z",
    "periodTo": "2026-09-29T08:00:00Z",
    "currency": "string",
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ],
    "totals": {
      "suppliers": 0,
      "locations": 0,
      "storefronts": 0,
      "warehouses": 0,
      "channels": 0,
      "purchaseSpend": 0,
      "salesRevenue": 0
    }
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Models

The operations on this page use these object types. Select a type to see its fields.

NetworkEdgeResponse

One edge in the supply-chain network graph: a flow of purchase orders, transfer orders, or sales orders between two nodes over a period.

FieldTypeDescription
idstring
sourceIdstring (uuid)
targetIdstring (uuid)
kindenum NetworkEdgeKindOne of: PurchaseOrder, TransferOrder, SalesOrder.
countinteger (int32)
valuenumber (double)
inTransitCountinteger (int32)The count of orders on this edge that are still in transit. Zero for a sales edge.
inTransitValuenumber (double)The value of orders on this edge that are still in transit. Zero for a sales edge.
NetworkInsightResponse

The supply-chain network graph for a business over a period: every supplier, location and sales-channel node, plus the purchase-order, transfer-order and sales-order edges between them.

FieldTypeDescription
periodFromstring (date-time)
periodTostring (date-time)
currencystringThe most common sale currency in the period. Null with no sales.
nodesNetworkNodeResponse[]
edgesNetworkEdgeResponse[]
totalsNetworkTotalsResponse
NetworkNodeResponse

One node in the supply-chain network graph: a supplier, a location, or a sales channel.

FieldTypeDescription
idstring (uuid)
kindenum NetworkNodeKindOne of: Supplier, Location, Channel.
titlestring
locationTypeenum BusinessLocationTypeOne of: Office, Warehouse, Storefront, Remote, Other, Headquarters, Factory.
channelKindenum SalesChannelKindOne of: Direct, PointOfSale, Online, Marketplace.
latitudenumber (double)Set for a supplier node and a location node. Null when the address is missing.
longitudenumber (double)Set for a supplier node and a location node. Null when the address is missing.
countrystringSet only for a Supplier node with an address.
NetworkTotalsResponse

Summary counts and monetary totals for the supply-chain network graph over a period.

FieldTypeDescription
suppliersinteger (int32)
locationsinteger (int32)
storefrontsinteger (int32)
warehousesinteger (int32)
channelsinteger (int32)
purchaseSpendnumber (double)
salesRevenuenumber (double)