Stats

Stats that are generated over different aspects of a dossier.

Stats

GET /api/v1/dossier/:epd_ids/stats

Parameters

Name	Type	Description
epd_ids	`string	array of string`

Response

Sample request

HTTP

HTTP Request

GET /api/v1/dossier/:epd_ids/stats HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_API_TOKEN

cURL

cURL Request

curl "https://api.example.com/api/v1/dossier/:epd_ids/stats" \
  -u "username:password"

PowerShell

PowerShell Request

$username = "username"
$password = "password"
$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(("{0}:{1}" -f $username, $password)))

$headers = @{
    "Authorization" = "Basic $base64AuthInfo"
}

Invoke-RestMethod -Uri "https://api.example.com/api/v1/dossier/:epd_ids/stats" `
  -Method GET `
  -Headers $headers

{
  "1234567890": {
    "responses": {
      "total": 2,
      "completed": 10,
      "aborted": 10,
      "expired": 10,
      "pending": 10,
      "scheduled": 10,
      "open": 10
    },
    "invitations": {
      "total": 10,
      "active": 10,
      "expired": 10,
      "unexpired": 10
    },
    "protocol_subscriptions": {
      "total": 2,
      "to_be_prepared": 2,
      "to_be_stopped": 0
    }
  },
  "1234567891": {
    "responses": {
      "total": 2,
      "completed": 10,
      "aborted": 10,
      "expired": 10,
      "pending": 10,
      "scheduled": 10,
      "open": 10
    },
    "invitations": {
      "total": 10,
      "active": 10,
      "expired": 10,
      "unexpired": 10
    },
    "protocol_subscriptions": {
      "total": 2,
      "to_be_prepared": 2,
      "to_be_stopped": 0
    }
  },
  "1234567892": {
    "responses": {
      "total": 2,
      "completed": 5,
      "aborted": 10,
      "expired": 10,
      "pending": 10,
      "scheduled": 10,
      "open": 10
    },
    "invitations": {
      "total": 10,
      "active": 10,
      "expired": 10,
      "unexpired": 10
    },
    "protocol_subscriptions": {
      "total": 2,
      "to_be_prepared": 2,
      "to_be_stopped": 0
    }
  }
}