GET /v1/signature/stats

GET

/v1/signature/stats

curl --request GET \
  --url 'https://api.asap.cool/v1/signature/stats?from=example&to=example' \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• api_key
  signature:read
• session

Parameters

Query Parameters

from

required

string

Inclusive lower bound (YYYY-MM-DD).

to

required

string

Inclusive upper bound (YYYY-MM-DD).

Responses

200

Envelope flow over the window.

Media typeapplication/json

Response of GET /v1/signature/stats.

object

awaiting_count

required

Envelopes waiting on a signer right now (window-invariant).

integer format: int64

by_status

required

Status mix of the envelopes created in the window; absent statuses are omitted.

Array<object>

Envelopes created in the window in one status.

object

count

required

How many.

integer format: int64

status

required

Status token (draft, sent, in_progress, completed, declined, expired, cancelled).

string

completion_rate_bp

Completed over sent (non-draft, non-cancelled) envelopes created in the window, in basis points; null when none was sent.

integer | null format: int64

median_hours_to_complete

Median hours from creation to completion over the window’s completions.

integer | null format: int64

series

required

Month series over the window, gap-filled, oldest first.

Array<object>

One month of envelope flow.

object

completed_count

required

Envelopes completed that month.

integer format: int64

period

required

Month, YYYY-MM.

string

sent_count

required

Envelopes sent that month.

integer format: int64

Example ^generated

{
  "awaiting_count": 1,
  "by_status": [
    {
      "count": 1,
      "status": "example"
    }
  ],
  "completion_rate_bp": 1,
  "median_hours_to_complete": 1,
  "series": [
    {
      "completed_count": 1,
      "period": "example",
      "sent_count": 1
    }
  ]
}

401

No active org.

Media typeapplication/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

403

Missing signature:read scope.

Media typeapplication/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

422

Invalid window (bad date, from > to, span > 366d).

Media typeapplication/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}