Monogoto
Back to Monogoto website
  • Welcome
  • Getting Started
    • Quick Start
    • Device Configurations
      • IoT Modules
        • NORDIC nRF9160 DK
        • Quectel BG95-MX
        • Quectel BG96
        • Murata LBAD0XX1SC-DM
          • Satellite NTN Network
        • Sierra Wireless WP7607
        • Sierra Wireless WP7610
        • Sierra Wireless MC7700
        • SIMCom SIM7070G
          • Waveshare SIM7070G
        • SIMCom SIM7600G-H
          • Waveshare SIM7600G-H
        • Telit HE910
        • Thales Cinterion TX62
        • u-blox SARA R4
          • SODAQ SARA R41XM
        • Cellular Devices
          • Openwrt EG95
          • ProView 4GPro-W
          • Teltonika RUT240
          • Teltonika FMB920
          • InHand IR302
          • Provision-ISR PR-LTE01W
          • Sierra Wireless RV50 AirLink
          • Smart Cash Register Configuration to Use Cellular SIM as WiFi Backup
          • Nayax Nova 40
      • iPhone Device
      • Android Device
      • Raspberry Pi
    • Monogoto SIM
      • IoT SIM card
      • Embedded SIM
      • eSIM
      • iSIM
        • Murata LBAD0XX1SC
        • Quectel BG770A-SN
      • SGP.32
        • Kigen Pulse
      • Monogoto SIM Tool Kit (MTK)
    • Cellular Identities in Monogoto
    • Coverage Lists
      • Identity B Coverage
      • Identity C Coverage
      • Identity E Coverage
      • Identity F Coverage
      • Identity P Coverage
      • Identity U Coverage
      • NTN Satellite Coverage
      • LP-WAN Coverage
    • Features List
    • Community Forum
  • FAQ
  • Hub
    • Intro
      • Signup
      • Login
      • Logout
      • Users
        • Create a new user
        • Delete a user
        • Manage users
        • User password reset
      • General Elements
    • Dashboards
      • Active SIMs and Data Usage
        • Daily Active Things
        • Daily Data Usage
        • Top Consuming Things
        • Top Profiles in Use
        • Top Groups by Data Usage
        • Top Networks by Data Usage
        • Top Groups by Active Things
        • Top Networks by Active Things
      • Data Flows
        • Data Transfer
        • Top Destinations
        • Breakout
        • Services
        • Protocols
        • TCP Flags
        • Top Things (upload/download)
    • Things
      • Thing details
        • Understanding OPLMN and FPLMN on the Thing details page
      • Quality of Service
        • Thing QoS tests for public connectivity
        • Thing QoS monitoring for private connectivity
      • SMS
        • Incoming SMS
        • Outgoing SMS
        • SMS Monitoring
      • Location Service
      • NetFlow
    • Campaigns
      • Campaigns Table
      • Campaign Details
      • SMS Campaign
    • Private Networks
      • Backhaul
      • Edge
        • Edge Events
          • Time
          • Messages
          • msg-type
          • Node
          • Direction
          • Interface
          • Type
      • Radio
    • Inbox
    • Integrations
      • Slack
      • Zapier
      • Webhook
        • Webhook CDRs
          • Webhook SMS CDR
          • Webhook DATA CDR
      • Email
    • Captures
      • Basics on How to Read a Packet Capture File
    • Orders
      • Create a new order
    • Payments
  • Advanced Console
    • Intro
    • Security
    • Network
      • Create new Network
      • Edit Network Settings
      • Apply Network Settings
      • Delete Network
      • Add Network NAT
      • Edit Network NAT
      • Delete Network NAT
      • Add Network Route
      • Edit Network Route
      • Delete Network Route
      • Add Network VPN
      • Network VPN status
      • Edit Network VPN
      • Delete Network VPN
      • Download Network VPN configuration
      • Reconnect Network VPN
      • Ping Network VPN
      • How Devices in The Same Network Can Communicate with Each Other?
    • Things Groups
      • Create Things Group
      • Assign Things to Group
      • Edit Things Group
      • Delete Things Group
      • Override Roaming Policy
    • Things
      • Define Thing Status
      • Edit Things Details
      • Refresh Connection
    • Alerts
      • Alert Metrics (types)
      • Create New Alert
      • Disable/Enable Alert
      • Edit Alert
      • Delete Alert
    • Global Pools
    • Price Plans
    • Webhooks
      • Outgoing (MO) SMS Webhook
      • Incoming (MT) SMS Webhook
      • Outgoing (MO) Voice Webhook
      • Incoming (MT) Voice Webhook
      • Triggered Alert Webhook
  • Developer
    • API
      • Authentication
      • Things
        • Get Things List
        • Get Thing Information
        • Get Thing State
        • Update Thing State
        • Update Thing Name
        • Update Thing Description
        • Get Thing Data Session Status
        • Get Thing ICCID using IMSI
        • Get Thing Lifetime Data Usage
        • Get Thing Events Logs
        • Ping Thing IP Address
        • Lock Thing to IMEI
        • Download Thing PCAP File
        • Refresh Thing Network Connection
        • Get Things Services Usage Report
      • Things Groups
        • Get Things Group List
        • Move Thing to Different Things Group
        • Get Things Group Information
        • Lock Things Group to IMEI range (TAC)
      • eSIM
        • Get an eSIM
        • Cancel an eSIM
        • Download an eSIM
      • Alerts
        • Get Triggered Alerts
      • SMS
        • Check if MT SMS was Received
        • Send SMS to Thing
      • Pricing
        • Get Pricing Plan Information
      • Get Roaming Policy
    • Cloud Integrations
      • AWS IoT Core
      • Ubidots
  • Private Networks
    • Intro
      • Getting Started
      • Spectrum Allocation
    • Monogoto Edge
      • 4G Edge Components
      • 5G Edge Components
      • Edge NUC
      • Edge API
        • Authentication
        • Get Edge Configuration
        • Get Edge ID
        • Get Edge CID
        • Get MME S6A And AMF AUSF Status
        • Get Radio List
        • Get Subscriber Information
        • Get Subscription Status
        • Patch Subscription Status
        • Get IMSI IP Mapping
        • Patch IMSI IP Mapping
        • Delete IMSI IP Mapping
        • Get PLMN
        • Post PLMN
        • Get Network Operator Name
        • Patch Network Operator Name
        • Get APN
        • Get APN IP Pool Mapping
        • Get CDR Logs
        • Post PING
        • Get iperf
        • Patch iperf
        • Get Speed Test
        • Get Data Speed
        • Get Capture
        • Post Capture
    • eNodeB
      • Airspan AirVelocity 1500
      • Baicells Nova 227
      • Baicells Nova 442i
      • Baicells Neutrino 430
      • Baicells Nova 230i
      • BreezeCOMPACT 1000
      • Foxconn T99B226
      • Ubiik goRAN
      • Ubiik FreeRAN
      • T&W N02008
      • Mosolabs SCE4255W
      • Mosolabs SCO4255P
    • gNodeB
      • Mosolabs SCE5164
      • Baicells Stellar 227
    • CPE & UE
      • Airspan AirSpot 5410
      • Sierra Wireless EM7565
      • DG505G CBRS 5G USB Dongle
      • DG10 CBRS USB Dongle
      • D-Link DWP-1010W CPE
      • D-Link DWM-311-G 5G M2M
      • D-Link G530 Router
      • IPC SCB800 CBRS Camera
      • Telit LM960A9-P
      • Moxa 5G CCG-1510-US-T
      • InHand 5G ODU2000
      • Peplink MAX BR1 Mini 5G
      • T&W 5G Router
      • Telit LM960A18
      • Baicells EG7010C-M11 CPE
      • Baicells EG7035E-M11 CPE
      • Baicells EG8015G-M11 CPE
      • Telrad 9000 CPE
      • SRW620 CPE
      • Amit IDG500-0GT01
      • Jacs TD0231 Router
  • NTN Satellite Networks
    • NTN Satellite Coverage
    • NTN Billing
    • NB-IoT: Signaling NIDD vs IP Connectivity
    • VPNs in NTN
    • UDP Communication in NTN
    • How to Order NTN Developer Kit?
    • NTN Certified Devices
      • NTN Certified Modules
        • Murata LBAD0XX1SC-DM Satellite NTN Network
        • Quectel BG95-S5 Satellite NTN Network
        • Quectel BG770A-SN Satellite NTN Network
        • Quectel CC660D-LS Satellite NTN Network
        • SIMCom 7070G-HP-S Satellite NTN Network
        • Murata ALT1250 Satellite NTN Network
      • NTN Certified Chipsets
  • University
    • AT Commands
      • What AT Commands Should I Use to Debug a Connectivity Issue?
      • How to Send AT Commands to a Teltonika Router?
    • LTE bands
    • RAT Type (Radio Access Technology)
    • Low Power Modes: eDRX & PSM
    • What is MCC/MNC?
    • Glossary
Powered by GitBook
On this page

Was this helpful?

  1. Developer
  2. API
  3. Things

Get Things Services Usage Report

This guide will show you how you can get your Things (SIM) Usage Report via an API command.

PreviousRefresh Thing Network ConnectionNextThings Groups

Last updated 5 months ago

Was this helpful?

Please note that in order to get Services Usage Report you will need to run multiple API commands:

1st API command - Create Report template

Create Report template

POST https://console.monogoto.io/report-template

Headers

Name
Type
Description

YOUR_TOKEN*

String

Your authentication token

Request Body

Name
Type
Description

REPORT_NAME*

String

Report name

REPORT_DESCRIPTION*

String

Report description

START_DATE*

String

END_DATE*

String

{
    Newly created Report Template ID
}
{
    "message": "string"
}
{
    Unauthorized
}
{
    "message": "string"
}

Example using cURL:

curl -X POST \
     --url "https://console.monogoto.io/report-template/" \
     -H "accept: application/json" \
     -H "Authorization: Bearer {YOUR_TOKEN}" \
     -d "{ \"Name\": \"{REPORT_NAME}\", \"Description\": \"{REPORT_DESCRIPTION}\", \"GroupBy\": \"servingNetwork\", \"rateByCurrentPricePlan\": true, \"ReportType\": \"rating\", \"ReportPeriod\": { \"startDate\": {START_DATE}, \"endDate\": {END_DATE}}}" \

Example of request

curl -X POST \
     --url "https://console.monogoto.io/report-template/" \
     -H "accept: application/json" \
     -H "Authorization: Bearer eyJhb6IkpXVCJ9.eyJSb2xlIjoiVXN4lclByb2ZpbGVJZF9kZGM2MThhNC0wNTI1LTQ2MmUtYWN3NzhhMGQxYmbSI6Im4zgFkbWluIiwiQ3VzdG9tsbCwiVXNlcklkIjoiVklkXzg5Yj5Y2OGEyUtNDQThhLTEzZjA0MzJhZDE3YyINTAzgZmUtZGI51My00ZjRiLTktN2U5Yjc0ZWU1ZThlIiwiaWNzM3MjI5L2MDY3NTE2Mjl9.99aSLzP7kTgK6TZGW-xalrMu0GkW6viunt3XxbNng" \
     -d "{ \"Name\": \"September_report\", \"Description\": \"September_report\", \"GroupBy\": \"servingNetwork\", \"rateByCurrentPricePlan\": true, \"ReportType\": \"rating\", \"ReportPeriod\": { \"startDate\": 1661979600000, \"endDate\": 1664571599000}}" \

Example of response to our request:

ReportTemplateId_a14901d4b-7691-4548-8110-72abcba0be22

2nd API command - Generate Report using the created template

Generate Report using the created template

POST https://console.monogoto.io/report-history/{reportTemplateId}

Path Parameters

Name
Type
Description

REPORT_TEMPLATE_ID*

String

Headers

Name
Type
Description

YOUR_TOKEN*

String

Your authentication token

Newly generated Report History ID
{
    "message": "string"
}
{
    "message": "string"
}
{
    "message": "string"
}

Please note that this API may take a while to be completed if you have a lot of Things (SIM) in your Monogoto account.

Example using cURL:

curl -X POST \
     --url "https://console.monogoto.io/report-history/{REPORT_TEMPLATE_ID}" \
     -H "accept: application/json" \
     -H "Authorization: Bearer {YOUR_TOKEN}" \

Example of request

curl -X POST \
     --url "https://console.monogoto.io/report-history/ReportTemplateId_a14901d4b-7691-4548-8110-72abcba0be22" \
     -H "accept: application/json" \
     -H "Authorization: Bearer eyJhb6IkpXVCJ9.eyJSb2xlIjoiVXN4lclByb2ZpbGVJZF9kZGM2MThhNC0wNTI1LTQ2MmUtYWN3NzhhMGQxYmbSI6Im4zgFkbWluIiwiQ3VzdG9tsbCwiVXNlcklkIjoiVklkXzg5Yj5Y2OGEyUtNDQThhLTEzZjA0MzJhZDE3YyINTAzgZmUtZGI51My00ZjRiLTktN2U5Yjc0ZWU1ZThlIiwiaWNzM3MjI5L2MDY3NTE2Mjl9.99aSLzP7kTgK6TZGW-xalrMu0GkW6viunt3XxbNng" \

Example of response to our request:

ReportHistoryId_611bac7b-abc9-4c18-9cbb-a497889180b7

3rd API command - Get CSV Report location

Get CSV Report location

GET https://console.monogoto.io/report-history/byTemplate

Headers

Name
Type
Description

YOUR_TOKEN*

String

Your authentication token

[
  {
    "Name": "string",
    "ReportTemplateDescription": "string",
    "ReportTemplateName": "string",
    "FilterBy": "string",
    "FilterByItems": {
      "CustomerId": [
        null
      ],
      "ThingsGroupId": [
        null
      ],
      "ThingId": [
        null
      ],
      "TagId": [
        null
      ]
    },
    "GroupBy": "string",
    "GroupByInterval": "string",
    "ReportType": "string",
    "ReportPeriod": {
      "startDate": "2022-10-04T12:56:06.957Z",
      "endDate": "2022-10-04T12:56:06.957Z"
    },
    "CustomerId": "string",
    "OrganizationId": "string",
    "ReportTemplateId": "string",
    "ReportHistoryId": "string",
    "DateCreated": "2022-10-04T12:56:06.957Z",
    "DateModified": "2022-10-04T12:56:06.957Z",
    "Type": "string"
  }
]
{
    "message": "string"
}
{
    "message": "string"
}

Example using cURL:

curl -X GET \
     --url "https://console.monogoto.io/report-history/report-history/byTemplate" \
     -H "accept: application/json" \
     -H "Authorization: Bearer {YOUR_TOKEN}" \

Example of request

curl -X GET \
     --url "https://console.monogoto.io/report-history/report-history/byTemplate" \
     -H "accept: application/json" \
     -H "Authorization: Bearer eyJhb6IkpXVCJ9.eyJSb2xlIjoiVXN4lclByb2ZpbGVJZF9kZGM2MThhNC0wNTI1LTQ2MmUtYWN3NzhhMGQxYmbSI6Im4zgFkbWluIiwiQ3VzdG9tsbCwiVXNlcklkIjoiVklkXzg5Yj5Y2OGEyUtNDQThhLTEzZjA0MzJhZDE3YyINTAzgZmUtZGI51My00ZjRiLTktN2U5Yjc0ZWU1ZThlIiwiaWNzM3MjI5L2MDY3NTE2Mjl9.99aSLzP7kTgK6TZGW-xalrMu0GkW6viunt3XxbNng" \

Example of response to our request:

{
  "dbResponse": [
    {
      "ReportHistoryId": "ReportHistoryId_611bac7b-abc9-4c18-9cbb-a497889180b7",
      "ReportTemplateId": "ReportTemplateId_a14901d4b-7691-4548-8110-72abcba0be22",
      "ReportType": "rating",
      "FilterBy": "none",
      "FilterByItems": {},
      "OrganizationId": "OrganizationId_2ds578d7d-abc9-4123-acbb-1ec67a98b01a",
      "CustomerId": "cid_eb426486-488a-4f44-9c6d-3627a66150cb",
      "GroupBy": "servingNetwork",
      "GroupByInterval": "d",
      "ReportTemplateName": "September_report",
      "ReportTemplateDescription": "September_report",
      "ReportPeriod": {
        "startDate": 1661979600000,
        "endDate": 1664571599000
      },
      "csvPath": "/efs/reports/csv/2022/10/4/Report_September_report_#8d351.csv",
      "pdfPath": "/efs/reports/pdf/2022/10/4/Report_September_report_#8d351.pdf",
      "ReportData": null,
      "Name": "Report September_report #8d351",
      "rateByCurrentPricePlan": false,
      "Type": "ReportHistory",
      "DateCreated": 1664887341012
    }

4th API command - Download CSV Report information

Download CSV Report information

GET https://console.monogoto.io /report-history/downloadReport/csv/{csvPath}

Path Parameters

Name
Type
Description

CSV_PATH*

String

Headers

Name
Type
Description

YOUR_TOKEN*

String

Your authentication token

The CSV contents of the reports
{
    "message": "string"
}
{
    "message": "string"
}
{
    "message": "string"
}

Example using cURL:

curl -X GET \
     --url "https://console.monogoto.io/https://console.monogoto.io /report-history/downloadReport/csv/{csvPath}" \
     -H "accept: application/json" \
     -H "Authorization: Bearer {YOUR_TOKEN}" \

Please note that in csvPath some symbols will need to be converted to numbers and letters:

/ - will be need to be replaced with %2F

# - will need to be replaced with %23

Example of csvPath:

/efs/reports/csv/2022/10/4/Report_September_report_#8d351.csv

Example after csvPath symbols were changed to code values:

%2Fefs%2Freports%2Fcsv%2F2022%2F10%2F4%2FReport_September_report_%238d351.csv

Example of request

curl -X GET \
     --url "https://console.monogoto.io/https://console.monogoto.io /report-history/downloadReport/csv/%2Fefs%2Freports%2Fcsv%2F2022%2F10%2F4%2FReport_September_report_%238d351.csv" \
     -H "accept: application/json" \
     -H "Authorization: Bearer eyJhb6IkpXVCJ9.eyJSb2xlIjoiVXN4lclByb2ZpbGVJZF9kZGM2MThhNC0wNTI1LTQ2MmUtYWN3NzhhMGQxYmbSI6Im4zgFkbWluIiwiQ3VzdG9tsbCwiVXNlcklkIjoiVklkXzg5Yj5Y2OGEyUtNDQThhLTEzZjA0MzJhZDE3YyINTAzgZmUtZGI51My00ZjRiLTktN2U5Yjc0ZWU1ZThlIiwiaWNzM3MjI5L2MDY3NTE2Mjl9.99aSLzP7kTgK6TZGW-xalrMu0GkW6viunt3XxbNng" \

Example of response to our request showing CSV file information:

Thing Name,IMSI,MSISDN,Roaming Partner,Data,SMS,MO SMS,MT SMS,Voice,MO VOICE,MT VOICE,Total Before Credit,Credit,Total
"ICCID 8912372646888991, 8912372646888991",1234567891011,+420123456789,Bite , 140.25 MB,,,,,,,,,0.9677
"ICCID 8912372646888991, 8912372646888991",1234567891011,+420123456789,,140.25 MB,,,,,,,0.9677,0.0000,0.9677
"ICCID 8912372646888992, 8912372646888992",1234567891012,+420123456790,OMNITEL , 64.34 MB,,,,,,,,,0.4504
"ICCID 8912372646888992, 8912372646888992",1234567891012,+420123456790,,64.34 MB,,,,,,,0.4504,0.0000,0.4504
"ICCID 8912372646888993, 8912372646888993",1234567891013,+420123456791,Bite , 28.9 MB, 2,,,,,,,,0.1994
"ICCID 8912372646888993, 8912372646888993",1234567891013,+420123456791,,28.9 MB,,,2,,,,0.1994,0.0000,0.1994

Start date of the Report in epoch format with milliseconds.

End date of the Report in epoch format with milliseconds.

Report template ID, it can be seen in response of

In the response to our request, you will need to find a Report matching our or . Then take csvPath and use it in the .

CSV file path that was received in

Create Report template
Generate Report using the created template
Get CSV Report location
Download CSV Report informaiton
Report template ID
Report history ID
4th API command
You can use converter following this link
You can use converter following this link
Report template creation (1st API command)
3rd API to get Report location

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.1.1

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.1.1

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.1.1

  • 1st API command - Create Report template
  • Create Report template
  • Example using cURL:
  • 2nd API command - Generate Report using the created template
  • Generate Report using the created template
  • Example using cURL:
  • 3rd API command - Get CSV Report location
  • Get CSV Report location
  • Example using cURL:
  • 4th API command - Download CSV Report information
  • Download CSV Report information
  • Example using cURL: