Skip to content

Get Api Usage API#

By using ApiUsage API, you can get the API usage report.

Note

  1. User can get data from the last 18 months
  2. User can get maximum 90 days data in one api call
  3. If user passes email parameter value as true, user will get csv report on logged in email-id.

Route

/enriched/{flynn-version}/api-usage/report?from-date={fromDate}&to-date={toDate}&email={email}

  • active ‘flynn-version’: v1.0
  • method: GET

URL Parameters#

Name Description Type Mandatory
flynn-version version of the API
for example, v1.0		 string true

QUERY Parameters#

Name Description Type Mandatory example
from-date From date String
Format YYYYMMDD		 true 20250101
to-date To date String
Format YYYYMMDD		 true 20250101
email Email-Id Boolean true true

Headers#

Header Key Name Description Mandatory
X-FLYNN-N-ORG-ID Flynn organization ID true
X-FLYNN-N-USER-TOKEN Flynn User token true
Status Code: 200#

Successful response will be an async task-id.
Using this task-id you will be able to fetch the status of the request.

Sample Response Body

 {
  "status": "1",
  "data": {
    "task-id": "2a51e392-529c-4b5a-bfd8-ca14d510a68d"
  },
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
 }

Since, this is a long-running task. Result of the task is downloaded once the process is completed.
To check the process status of the task, call status api.
To get the result of the task, call download api.

Download API Response:#

Download API response is unique for each API.
In response you get zip file.
If records are found for given period, API will be generate zip file containing one json file (result.json ) and one csv file (taskId_fromDate_toDate.csv).
CSV file will be contains API usage data.

content of json file (‘result.json’) file

{
  "status": "1",
  "data": "2a51e392-529c-4b5a-bfd8-ca14d510a68d_27-02-2025_27-02-2025.csv",
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}

content of csv file (‘taskId_fromDate_toDate.csv’).

Created On Api Type Event Type Action Api Count GSTIN
2025-03-17 basic-einvoice IrpGenerateIrn ApiCallToGsp 30 27AAAPI3182M002
2025-03-17 enriched-gstn GstnImsGetRequestStatus ApiCallToGsp 1 33AOZPD0347J2ZR
2025-03-17 basic-ewb EwbExtendValidity ApiCallToGsp 3 27AAAPI3182M002

If no records are found for the given period, zip file will be contains only one json file (result.json )

content of json file (‘result.json’) file

{
  "status": "1",
  "data": null,
  "error": null,
  "info": null,
  "additionalInfo": {
    "key": {
      "message": "No records found for the period"
    }
  },
  "alert": null
}