Documents Generated

GET /api/v1/metrics/documents/generated

Personal access token & O auth2

Get the total number of documents generated for a firm on the current date or the end of the date supplied.

Query parameters

date string

The date to get the key metric from in YYYY-MM-DD format (calculations are made from the end of the day).

application/json

Body

date date

The date which you would like to run the key metric from.

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  The value of the key metric.
  
  Hide data attributes Show data attributes object
  
  metric string
  
  data string
  
  date string
  
  requested_at string

GET /api/v1/metrics/documents/generated

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/metrics/documents/generated' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"date":"2023-01-01"}'

Request examples

{
  "date": "2023-01-01"
}

Response examples (200)

{
  "data": [
    {
      "data": "123",
      "date": "2023-06-30",
      "metric": "time_logged",
      "requested_at": "2023-07-01 12:30:45"
    }
  ]
}