Get templates performance report

Summarizes how templates perform in a period of local days: stat cards, usage, time to complete, activity over time, outcomes per template and time per signer, as the app's templates report shows. Filters: vault and owner. Administrators only.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Report computed successfully

Bodyapplication/json

Example

{
    "statCards": {
        "activeTemplates": 0,
        "templateEnvelopes": 0,
        "templateSharePercent": 0,
        "medianTimeSeconds": 0,
        "adHocMedianTimeSeconds": 0,
        "unusedTemplates": 0
    },
    "usage": [
        {
            "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
            "templateName": "string",
            "envelopes": 0
        }
    ],
    "timeToComplete": [
        {
            "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
            "templateName": "string",
            "completed": 0,
            "stats": {
                "min": 0,
                "q1": 0,
                "median": 0,
                "q3": 0,
                "max": 0
            },
            "outliers": [
                0
            ]
        }
    ],
    "activity": {
        "interval": "string",
        "items": [
            {
                "date": "2019-08-24",
                "fromTemplate": 0,
                "adHoc": 0
            }
        ]
    },
    "outcomeByTemplate": {
        "items": [
            {
                "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
                "templateName": "string",
                "envelopes": 0,
                "completed": 0,
                "inProgress": 0,
                "expired": 0,
                "rejected": 0,
                "cancelled": 0
            }
        ],
        "others": {
            "templates": 0,
            "completed": 0,
            "inProgress": 0,
            "expired": 0,
            "rejected": 0,
            "cancelled": 0
        }
    },
    "signersTime": [
        {
            "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
            "templateName": "string",
            "envelopes": 0,
            "averageSigners": 0,
            "medianSeconds": 0
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429