--- title: Get aggregated report about Patients slug: get-aggregated-report-about-patients docTags: createdAt: 2026-04-21T15:22:49.957Z --- { "id": "dSfKrx-eJCRnAU1S9Wc-v", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://developer.digitail.io/api/v1/pets-report/aggregated", "servers": [ { "url": "https://developer.digitail.io/api/v1/pets-report/aggregated", "description": "Sandbox server (uses test data)" }, { "url": "https://vet.digitail.io/api/v1/pets-report/aggregated", "description": "Production server (uses live data)" } ], "name": "Get aggregated report about Patients", "description": "

Permissions needed: NONE\nReturns aggregated reports about patients in the currently authenticated user's clinic

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "without_archived", "type": "boolean", "description": "

if true, will exclude archived patients from the report

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "passport", "name": "passport", "kind": "optional", "type": "oauth2", "description": "Laravel passport oauth2 security.", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://digitail.test/oauth/authorize", "tokenUrl": "https://digitail.test/oauth/token", "refreshUrl": "https://digitail.test/oauth/token" } } }, { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "species", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "chart", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "labels", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "series", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "number", "customType": "number[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "breakdown", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "label", "kind": "optional", "type": "string", "description": "" }, { "name": "amount", "kind": "optional", "type": "integer", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] } ] }, { "name": "breeds", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "chart", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "labels", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "series", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "number", "customType": "number[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "breakdown", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "label", "kind": "optional", "type": "string", "description": "" }, { "name": "amount", "kind": "optional", "type": "integer", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "description": "" }, { "name": "species_id", "kind": "optional", "type": "integer", "description": "" } ] } ] }, { "name": "age", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "chart", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "labels", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "series", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "number", "customType": "number[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "breakdown", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "label", "kind": "optional", "type": "string", "description": "" }, { "name": "amount", "kind": "optional", "type": "integer", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] } ] }, { "name": "reproductive_status", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "chart", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "labels", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "series", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "number", "customType": "number[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "breakdown", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "label", "kind": "optional", "type": "string", "description": "" }, { "name": "amount", "kind": "optional", "type": "integer", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] } ] } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "DJUQT37SXUXLpU9xCNdKN", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://developer.digitail.io/api/v1/pets-report/aggregated \\\n --header 'accept: application/json'" }, { "id": "jl15o1LVLBeqwX6fjhcP0", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/pets-report/aggregated\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "h9NYF5PcFBNPTSTsRrezU", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/pets-report/aggregated\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "rNSi1xmDi5KvhT9iQcGGT", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/pets-report/aggregated\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "DJUQT37SXUXLpU9xCNdKN" }, "results": { "languages": [ { "id": "wYiRTwxU7M3NbLhXcwS_3", "language": "200", "code": "// successful operation\n{\n \"data\": {\n \"species\": {\n \"chart\": {\n \"labels\": [\n \"\"\n ],\n \"series\": [\n 0\n ]\n },\n \"breakdown\": [\n {\n \"label\": \"\",\n \"amount\": 0,\n \"value\": \"\"\n }\n ]\n },\n \"breeds\": {\n \"chart\": {\n \"labels\": [\n \"\"\n ],\n \"series\": [\n 0\n ]\n },\n \"breakdown\": [\n {\n \"label\": \"\",\n \"amount\": 0,\n \"value\": \"\",\n \"species_id\": 0\n }\n ]\n },\n \"age\": {\n \"chart\": {\n \"labels\": [\n \"\"\n ],\n \"series\": [\n 0\n ]\n },\n \"breakdown\": [\n {\n \"label\": \"\",\n \"amount\": 0,\n \"value\": \"\"\n }\n ]\n },\n \"reproductive_status\": {\n \"chart\": {\n \"labels\": [\n \"\"\n ],\n \"series\": [\n 0\n ]\n },\n \"breakdown\": [\n {\n \"label\": \"\",\n \"amount\": 0,\n \"value\": \"\"\n }\n ]\n }\n }\n}" } ], "selectedLanguageId": "wYiRTwxU7M3NbLhXcwS_3" } }, "children": [ { "text": "" } ] }