Skip to main content
GET
/
api
/
v2
/
reporting
/
used-documents
/
Get documents usage report
curl --request GET \
  --url https://paradigm.lighton.ai/api/v2/reporting/used-documents/ \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {
    "usage_count": {
      "description": "<string>",
      "unit": "<string>"
    }
  },
  "reporting": [
    {
      "company": {
        "name": "<string>",
        "id": 123
      },
      "dates": [
        {
          "date": "2023-12-25",
          "documents": [
            {
              "document_filename": "<string>",
              "document_title": "<string>",
              "document_id": 123,
              "usage_count": 123
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

company_id
integer

The unique identifier of the company (optional for admin users).

end_date
string<date>

The end date for the report (optional, defaults to today).

start_date
string<date>
required

The start date for the report.

Response

Successful response

metadata
object
required
reporting
object[]
I