get your accounting metrics
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/orange-business:orange-business-accounting-v1-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Live Objects REST API Guide Accounting - V1 API
description: API description for Live Objects service
contact:
name: Live Objects Support
url: https://liveobjects.orange-business.com/#/cms/support
version: 2026.7.0
servers:
- url: https://liveobjects.orange-business.com
security:
- X-API-KEY: []
OAuth2.0: []
tags:
- name: Accounting - V1
description: get your accounting metrics
paths:
/api/v1/accounting/monthly:
get:
tags:
- Accounting - V1
summary: Get monthly accounting metrics
description: 'Get accounting metrics for a given period (up to 18 months). The data is aggregated by months.
The response contains 2 main sections : tenant and months.
The tenant section gives useful information related to the customer. It returns the current values, whatever has been specified in startMonth and endMonth parameters :
id : Live Objects identifier
name : tenant name in Live Objects
detailed offer and options, including the display name
properties : custom fields
The months section provides connectors and service metrics for each month.
connectors section (LoRa, mqtt (device),
mqtt application, http, lwm2m, sms_[server phone number],external):
connectors section (LoRa, mqtt (device), mqtt application, http, lwm2m, sms_[server phone number], external) :
traffic metrics:
msg: number of messages (no unit)
bytes: sum of the volume of all messages (unit: bytes)
virtualMsg: number of messages split by a size of 5kB (no unit).
Example: 1 msg with a size of 7kB = 1 msg and 2 virtualMsg
msgAckRequest: Deprecated. Always 0. LoRa specific. Number of acknowledgement requests sent for uplink messages.
inventory metrics:
numberOfCommunicatingNodes: this counter is available by connector: LoRa, mqtt, sms_[server phone number] or external.
It is a unique count of devices that send at least one uplink message to the platform (except for mqtt, see below).
More precisely, by connector:
LoRa: distinct devEUIs sending an uplink
mqtt: distinct clientIds that have been connected at least one time
external: distinct nodeIds behind an external connector that have been declared online or have published a dataMessage
sms: distinct MSISDNs sending a message
numberOfActivatedNodes: LoRa specific: count of unique devices allowed to communicate and paired to the network. Corresponding LoRa status : ACTIVATED or INITIALIZED.
numberOfActivatedLocationNodes: LoRa specific: count of unique Activated devices that had location lora option for the month.
numberOfActivatedAckUlNodes: LoRa specific: count of unique Activated devices that had AckUL lora option for the month.
service section:
deviceManagement
numberOfSuccessfulDownloads: count of all firmware downloads in success
storage
storedDataMessagesInMB: the total size of messages stored in database.
This size does not include technical data (for ex. Index).
Values in MB are rounded up.
The value differs from the sum of “IN” bytes sent to the platform because it includes data coming from enrichment/decoding/event processing features.
This information is available from June 2019.
twin
traffic virtualMsg In: number of incoming virtual messages generated by the twin service (amplification factor)
devices section:
numberOfRegisteredDevices: max number of registered devices during the month.
Additional info :
Traffic is split by connector type (mqtt, mqtt application, sms_[server phone number], LoRa, http, lwm2m, external) and by directions (in/out).
In: means incoming traffic (i.e. from "outside" into Live Objects) (mostly from objects) also called Uplink.
Out: any outgoing message (i.e. from Live Objects to "outside") except protocol messages (MQTT CONNACK, SUBACK … ) and messages consumed by applications on top of Live Objects (subscribe in MQTT application mode).
http specific:
IN traffic: sum (POST /api/v0/data/bulk & POST /api/v0/data/streams/{streamId})
mqtt specific:
IN & OUT traffic: after may 2020 : the mqtt section contains only traffic in device mode. Mqtt application mode is computed only for incoming traffic (IN).
No specific role on API key required.'
operationId: getMonthlyStatistics
parameters:
- name: startMonth
in: query
description: the requested start month as yyyy-MM. If missing, the current month is used. e.g. '2026-01'.
required: false
schema:
type: string
- name: endMonth
in: query
description: the requested end month as yyyy-MM. If missing, the current month is used. e.g. '2026-01'.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantMonthsMetrics'
/api/v1/accounting/daily:
get:
tags:
- Accounting - V1
summary: Get daily accounting metrics (Beta)
description: Get accounting metrics for a given period (from one day to 2 months) over the past 18 months.
operationId: getDailyStatistics
parameters:
- name: startDay
in: query
description: the requested start day as yyyy-MM-dd. If missing, the current day is used. e.g. '2026-01-19'.
required: false
schema:
type: string
- name: endDay
in: query
description: the requested end day as yyyy-MM-dd. If missing, the current day is used. e.g. '2026-01-19'.
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantDaysMetrics'
components:
schemas:
Inventory:
type: object
additionalProperties:
type: integer
format: int64
properties:
empty:
type: boolean
TenantExternalView:
type: object
properties:
id:
type: string
description: tenant Id
example: 57ed0a98266e260a12345
name:
type: string
description: tenant name
example: Tenant-test
offerAndOptions:
$ref: '#/components/schemas/OfferAndOptions'
description: detailed list of offer and options
example:
offer:
name: Discover_OFR_v2.2
displayName: Discover
options:
- name: option_name
displayName: option_display_name
properties:
type: object
additionalProperties:
type: string
description: tenant properties
example:
diseId: '12345678'
TenantMonthsMetrics:
type: object
properties:
tenant:
$ref: '#/components/schemas/TenantExternalView'
months:
type: array
description: Statistics per month
example:
- month: 2022-01
connectors:
lora:
traffic:
in:
msg: 54395
bytes: 572827
msgAckRequest: 1
out:
msg: 100
bytes: 2858
inventory:
numberOfCommunicatingNodes: 36
numberOfActivatedNodes: 65
numberOfActivatedLocationNodes: 30
numberOfActivatedAckUlNodes: 5
mqtt:
traffic:
in:
msg: 45000
virtualMsg: 45000
bytes: 1120000
out:
msg: 35220
virtualMsg: 35220
bytes: 18373042
inventory:
numberOfCommunicatingNodes: 2
mqttApplication:
traffic:
in:
msg: 4500
virtualMsg: 4500
bytes: 112000
external:
traffic:
in:
msg: 2
virtualMsg: 2
bytes: 20
out:
msg: 1
virtualMsg: 1
bytes: 100
inventory:
numberOfCommunicatingNodes: 1
http:
traffic:
in:
msg: 359
virtualMsg: 359
bytes: 167457
sms_20259:
traffic:
in:
msg: 10
virtualMsg: 10
bytes: 1100
out:
msg: 1
virtualMsg: 1
bytes: 10
inventory:
numberOfCommunicatingNodes: 1
lwm2m:
traffic:
in:
msg: 55425
virtualMsg: 55425
bytes: 2155073
out:
msg: 2488
virtualMsg: 2777
bytes: 1490326
inventory:
numberOfCommunicatingNodes: 4
services:
deviceManagement:
numberOfSuccessfulDownloads: 123
storage:
storedDataMessagesInMB: 456
twin:
traffic:
in:
virtualMsg: 30647
devices:
numberOfRegisteredDevices: 70
- month: 2022-02
connectors:
lora:
traffic:
in:
msg: 42716
bytes: 493582
msgAckRequest: 2
out:
msg: 77
bytes: 1474
inventory:
numberOfCommunicatingNodes: 39
numberOfActivatedNodes: 71
numberOfActivatedLocationNodes: 30
numberOfActivatedAckUlNodes: 5
mqtt:
traffic:
out:
msg: 43229
virtualMsg: 43229
bytes: 23198520
mqttApplication:
traffic:
in:
msg: 4322
virtualMsg: 4322
bytes: 2319852
http:
traffic:
in:
msg: 1085
virtualMsg: 1085
bytes: 545462
services:
deviceManagement:
numberOfSuccessfulDownloads: 100
storage:
storedDataMessagesInMB: 567
twin:
traffic:
in:
virtualMsg: 2658
devices:
numberOfRegisteredDevices: 70
items:
$ref: '#/components/schemas/MonthMetrics'
Traffic:
type: object
properties:
in:
type: object
additionalProperties:
type: integer
format: int64
properties:
empty:
type: boolean
out:
$ref: '#/components/schemas/MeterGroup'
TenantDaysMetrics:
type: object
properties:
tenant:
$ref: '#/components/schemas/TenantExternalView'
days:
type: array
description: Statistics per day
example:
- day: '2022-04-01'
connectors:
lora:
traffic:
in:
msg: 54395
bytes: 572827
msgAckRequest: 1
out:
msg: 100
bytes: 2858
inventory:
maxNumberOfEnabledNodes: 30
mqtt:
traffic:
in:
msg: 45000
virtualMsg: 45000
bytes: 1120000
out:
msg: 35220
virtualMsg: 35220
bytes: 18373042
mqttApplication:
traffic:
in:
msg: 4500
virtualMsg: 4500
bytes: 112000
external:
traffic:
in:
msg: 2
virtualMsg: 2
bytes: 20
out:
msg: 1
virtualMsg: 1
bytes: 100
http:
traffic:
in:
msg: 359
virtualMsg: 359
bytes: 167457
sms_20259:
traffic:
in:
msg: 10
virtualMsg: 10
bytes: 1100
out:
msg: 1
virtualMsg: 1
bytes: 10
services:
deviceManagement:
numberOfSuccessfulDownloads: 123
storage:
storedDataMessagesInMB: 456
twin:
traffic:
in:
virtualMsg: 30647
devices:
numberOfRegisteredDevices: 70
- day: '2022-04-02'
connectors:
lora:
traffic:
in:
msg: 42716
bytes: 493582
out:
msg: 77
bytes: 1474
inventory:
maxNumberOfEnabledNodes: 29
mqtt:
traffic:
out:
msg: 43229
virtualMsg: 43229
bytes: 23198520
mqttApplication:
traffic:
in:
msg: 4322
virtualMsg: 4322
bytes: 2319852
http:
traffic:
in:
msg: 1085
virtualMsg: 1085
bytes: 545462
lwm2m:
traffic:
in:
msg: 1994
virtualMsg: 1994
bytes: 607042
out:
msg: 19
virtualMsg: 19
bytes: 5
services:
deviceManagement:
numberOfSuccessfulDownloads: 100
storage:
storedDataMessagesInMB: 567
twin:
traffic:
in:
virtualMsg: 2658
devices:
numberOfRegisteredDevices: 70
items:
$ref: '#/components/schemas/DayMetrics'
MeterGroup:
type: object
additionalProperties:
type: integer
format: int64
properties:
empty:
type: boolean
Twin:
type: object
properties:
traffic:
$ref: '#/components/schemas/Traffic'
OfferAndOptions:
type: object
properties:
offer:
$ref: '#/components/schemas/BssRuleInfo'
description: name
example: Discover_OFR_v2.2
options:
type: array
description: displayName
example: Discover
items:
$ref: '#/components/schemas/BssRuleInfo'
BssRuleInfo:
type: object
properties:
name:
type: string
displayName:
type: string
Decoder:
type: object
properties:
traffic:
$ref: '#/components/schemas/Traffic'
ConnectorAccounting:
type: object
properties:
traffic:
$ref: '#/components/schemas/Traffic'
inventory:
type: object
additionalProperties:
type: integer
format: int64
properties:
empty:
type: boolean
DayMetrics:
type: object
properties:
day:
type: string
description: day in "YYYY-MM-DD" format.
example: '2020-04-01'
connectors:
type: object
additionalProperties:
$ref: '#/components/schemas/ConnectorAccounting'
description: connector (lora, mqtt, http) statistics
services:
$ref: '#/components/schemas/ServiceMetrics'
description: service statistics
devices:
$ref: '#/components/schemas/Inventory'
description: device statistics
MonthMetrics:
type: object
properties:
month:
type: string
description: month in "YYYY-MM" format.
example: 2019-01
connectors:
type: object
additionalProperties:
$ref: '#/components/schemas/ConnectorAccounting'
description: connector (lora, mqtt, http) statistics
services:
$ref: '#/components/schemas/ServiceMetrics'
description: service statistics
devices:
$ref: '#/components/schemas/Inventory'
description: device statistics
ServiceMetrics:
type: object
properties:
deviceManagement:
type: object
additionalProperties:
type: integer
format: int64
properties:
empty:
type: boolean
storage:
type: object
additionalProperties:
type: integer
format: int64
properties:
empty:
type: boolean
twin:
$ref: '#/components/schemas/Twin'
decoder:
$ref: '#/components/schemas/Decoder'
securitySchemes:
X-API-KEY:
type: apiKey
name: X-API-KEY
in: header
OAuth2.0:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://liveobjects.orange-business.com/api/v1/oauth2/authorize
tokenUrl: https://liveobjects.orange-business.com/api/v1/oauth2/token
refreshUrl: https://liveobjects.orange-business.com/api/v1/oauth2/token
scopes:
API_KEY_R: Read parameters and status of an API key.
API_KEY_W: Create, modify, disable an API key.
BOOTSTRAP_R: Read parameters and status of the LwM2M Bootstrap configurations and entries.
BOOTSTRAP_W: Create ans modify LwM2M Bootstrap configurations and entries.
BUS_CONFIG_R: Read config parameters of a FIFO queue.
BUS_CONFIG_W: Create, modify a FIFO queue.
BUS_R: Read data on the Live Objects bus. Minimum permission for the API key of an application collecting data on Live Objects in MQTT(s).
BUS_W: Publish data on the Live Objects bus.
CAMPAIGN_R: Read parameters and status of a massive deployment campaign on your Device Fleet.
CAMPAIGN_W: Create, modify a campaign on your Device Fleet.
CONNECTOR_ACCESS: Role to set on a external connector API key to allow only MQTT external connector mode
DATA_PROCESSING_R: Read parameters and status of an event processing rule or a Data decoder.
DATA_PROCESSING_W: Create, modify, disable an event processing rule or a Data decoder.
DATA_R: Read the data collected by the Store Service or search into this data using the Search Service.
DATA_W: Insert a data record to the Store Service. Minimum permission required for the API key of a device pushing data to Live Objects in HTTPS.
DEVICE_ACCESS: Role to set on a Device API key to allow only MQTT Device mode
DEVICE_R: Read parameters and status of a Device management.
DEVICE_W: Create, modify, disable a Device management, send command, modify config, update resource of a Device.
LOGS_R: Read the logs collected by the Audit Log service. This right allows users to use the Audit Log service as debugging tool.
SETTINGS_R: Read the tenant account custom settings.
SETTINGS_W: Create, modify tenant account custom settings.
USER_R: Read parameters and status of a user.
USER_W: Create, modify, disable a user.
externalDocs:
description: Live Objects Developer Guide
url: https://liveobjects.orange-business.com/doc/html/lo_manual_v2.html
x-examples: ''