Skip to main content
GET
/
v1
/
client
/
usage-report
Generate User Usage Report
curl --request GET \
  --url https://production.deepvue.tech/v1/client/usage-report \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'
{
  "code": 200,
  "timestamp": 1748417711157,
  "transaction_id": "5a936bcee02d4b7a974db19a4cd1185e",
  "sub_code": "SUCCESS",
  "message": "User usage report generated successfully",
  "data": {
    "file_url": "https://deepvue-tech.s3.ap-south-1.amazonaws.com/client/usage-report/9147835.xlsx",
    "usage_data": [
      {
        "Transaction Id": "9cb1fa27-c768-430c-9aa3-c13c477a1b0b",
        "Timestamp(UTC)": "2024-05-11T23:33:32.092089+00:00",
        "Product Id": "PAN-Plus",
        "Status": 200,
        "Message": "Invalid Pan Number.",
        "Charge": 2.95
      },
      {
        "Transaction Id": "fd93b66e-74e1-4150-8e0f-5b8f78a3a010",
        "Timestamp(UTC)": "2024-05-11T22:25:48.586394+00:00",
        "Product Id": "PAN-Plus",
        "Status": 200,
        "Message": "Pan Verified Successfully.",
        "Charge": 2.95
      },
      {
        "Transaction Id": "15d46c64-41fe-4938-8510-2aa87fba7694",
        "Timestamp(UTC)": "2024-05-11T22:25:07.844149+00:00",
        "Product Id": "PAN-Plus",
        "Status": 200,
        "Message": "Pan Verified Successfully.",
        "Charge": 2.95
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

ACCESS_TOKEN generated from the authorize endpoint. Should be included in the header as Bearer .

​
x-api-key
string
header
required

The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.

Query Parameters

​
generate_excel
boolean
default:false
​
since_date
string
required
​
until_date
string
required

Response

Successful Response