Documents Generated

GET /api/v1/metrics/documents/generated

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.

      Additional properties are allowed.
GET /api/v1/metrics/documents/generated 
curl \
 -X GET https://api.plannrcrm.com/api/v1/metrics/documents/generated \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"date":"2023-01-01"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "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"
    }
  ]
}