> For the complete documentation index, see [llms.txt](https://docs.vcheckglobal.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vcheckglobal.com/api-reference/monitoring/monitoring-exports.md). # Monitoring Exports Export monitoring alerts as Excel files - account-wide, by group, or by subject. ## Export All Alerts > Generates and downloads an Excel file containing all active monitoring alerts for the authenticated account.\ > \ > \*\*Important:\*\* The \`Accept\` header \*\*must\*\* be set to \`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\` to receive the file as a binary download. Without this header, the response body will be base64-encoded text instead of a valid Excel file.\ > \ > The response body is the \`.xlsx\` file itself. The \`Content-Disposition\` header provides the generated filename in the format: \`monitoring\_alerts\_all\_YYYYMMDD\_HHMMSS.xlsx\`.\ > \ > The file is also stored on S3 and an \`ExportExcel\` audit record is created.\ > \ > \### Example curl\ > \ > \`\`\`\ > curl -X POST "" \\\ > -H "Authorization: Bearer \" \\\ > -H "Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" \\\ > -OJ\ > \`\`\`\ > \ > \### Example Request\ > \ > No request body is required. Send a \`POST\` with the \`Accept\` header set to \`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\`.\ > \ > \### Example Response\ > \ > The response body is a binary Excel (\`.xlsx\`) file. Key response headers:\ > \ > \`\`\`\ > Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\ > Content-Disposition: attachment; filename="monitoring\_alerts\_all\_20260115\_103000.xlsx"\ > Content-Length: 24576\ > X-Total-Records: 150\ > \`\`\`
````json {"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Exports","description":"Export monitoring alerts as Excel files - account-wide, by group, or by subject."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/monitoring/alerts/export":{"post":{"tags":["Monitoring Exports"],"operationId":"exportMonitoringAlerts","summary":"Export All Alerts","description":"Generates and downloads an Excel file containing all active monitoring alerts for the authenticated account.\n\n**Important:** The `Accept` header **must** be set to `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` to receive the file as a binary download. Without this header, the response body will be base64-encoded text instead of a valid Excel file.\n\nThe response body is the `.xlsx` file itself. The `Content-Disposition` header provides the generated filename in the format: `monitoring_alerts_all_YYYYMMDD_HHMMSS.xlsx`.\n\nThe file is also stored on S3 and an `ExportExcel` audit record is created.\n\n### Example curl\n\n```\ncurl -X POST \"https://api-platform.vcheckglobal.net/v2/monitoring/alerts/export\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\" \\\n -OJ\n```\n\n### Example Request\n\nNo request body is required. Send a `POST` with the `Accept` header set to `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`.\n\n### Example Response\n\nThe response body is a binary Excel (`.xlsx`) file. Key response headers:\n\n```\nContent-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\nContent-Disposition: attachment; filename=\"monitoring_alerts_all_20260115_103000.xlsx\"\nContent-Length: 24576\nX-Total-Records: 150\n```\n","responses":{"200":{"description":"Excel file download. The response body is the `.xlsx` file itself.\n\n**Response headers:**\n- `Content-Disposition`: `attachment; filename=\".xlsx\"`\n- `Content-Length`: file size in bytes\n- `X-Total-Records`: number of alert records in the export\n\nThe file is also stored on S3 with a corresponding database audit record.\n\n### Export columns\n\nAlert ID, Subject Name, Subject Type, Group, Alert Type, Risk, Status, Alert Date, Agency, Category, Comments, Escalated, Created On, Updated On."},"403":{"description":"Forbidden - missing or invalid Client-ID credentials, insufficient scope, endpoint disabled via feature flag, or authenticated client has no linked account. Verify the scopes assigned to your credentials.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Authorization or access error message.","type":"string","default":"This endpoint is currently disabled."}}}}}},"500":{"description":"Internal server error - an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Internal server error message.","type":"string","default":"An unexpected error occurred while processing the request."}}}}}}}}}}} ```` ## Export Group Alerts > Generates and downloads an Excel file containing all active monitoring alerts for the specified group.\ > \ > \*\*Important:\*\* The \`Accept\` header \*\*must\*\* be set to \`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\` to receive the file as a binary download. Without this header, the response body will be base64-encoded text instead of a valid Excel file.\ > \ > The response body is the \`.xlsx\` file itself. The \`Content-Disposition\` header provides the generated filename in the format: \`monitoring\_alerts\_group\_{group\_id}\_YYYYMMDD\_HHMMSS.xlsx\`.\ > \ > The group must belong to the authenticated account. Returns 404 if the group does not exist or belongs to a different account.\ > \ > The file is also stored on S3 and an \`ExportExcel\` audit record is created.\ > \ > \### Example curl\ > \ > \`\`\`\ > curl -X POST "" \\\ > -H "Authorization: Bearer \" \\\ > -H "Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" \\\ > -OJ\ > \`\`\`\ > \ > \### Example Request\ > \ > No request body is required. Send a \`POST\` with the \`Accept\` header set to \`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\`.\ > \ > \### Example Response\ > \ > The response body is a binary Excel (\`.xlsx\`) file. Key response headers:\ > \ > \`\`\`\ > Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\ > Content-Disposition: attachment; filename="monitoring\_alerts\_group\_42\_20260115\_103000.xlsx"\ > Content-Length: 12288\ > X-Total-Records: 75\ > \`\`\`
````json {"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Exports","description":"Export monitoring alerts as Excel files - account-wide, by group, or by subject."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/monitoring/groups/{group_id}/alerts/export":{"post":{"tags":["Monitoring Exports"],"operationId":"exportMonitoringGroupAlerts","summary":"Export Group Alerts","description":"Generates and downloads an Excel file containing all active monitoring alerts for the specified group.\n\n**Important:** The `Accept` header **must** be set to `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` to receive the file as a binary download. Without this header, the response body will be base64-encoded text instead of a valid Excel file.\n\nThe response body is the `.xlsx` file itself. The `Content-Disposition` header provides the generated filename in the format: `monitoring_alerts_group_{group_id}_YYYYMMDD_HHMMSS.xlsx`.\n\nThe group must belong to the authenticated account. Returns 404 if the group does not exist or belongs to a different account.\n\nThe file is also stored on S3 and an `ExportExcel` audit record is created.\n\n### Example curl\n\n```\ncurl -X POST \"https://api-platform.vcheckglobal.net/v2/monitoring/groups/{group_id}/alerts/export\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\" \\\n -OJ\n```\n\n### Example Request\n\nNo request body is required. Send a `POST` with the `Accept` header set to `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`.\n\n### Example Response\n\nThe response body is a binary Excel (`.xlsx`) file. Key response headers:\n\n```\nContent-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\nContent-Disposition: attachment; filename=\"monitoring_alerts_group_42_20260115_103000.xlsx\"\nContent-Length: 12288\nX-Total-Records: 75\n```\n","parameters":[{"name":"group_id","in":"path","required":true,"description":"Unique monitoring group identifier.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Excel file download. The response body is the `.xlsx` file itself.\n\n**Response headers:**\n- `Content-Disposition`: `attachment; filename=\".xlsx\"`\n- `Content-Length`: file size in bytes\n- `X-Total-Records`: number of alert records in the export\n\nThe file is also stored on S3 with a corresponding database audit record.\n\n### Export columns\n\nAlert ID, Subject Name, Subject Type, Group, Alert Type, Risk, Status, Alert Date, Agency, Category, Comments, Escalated, Created On, Updated On."},"403":{"description":"Forbidden - missing or invalid Client-ID credentials, insufficient scope, endpoint disabled via feature flag, or authenticated client has no linked account. Verify the scopes assigned to your credentials.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Authorization or access error message.","type":"string","default":"This endpoint is currently disabled."}}}}}},"404":{"description":"Not found - group does not exist or does not belong to the authenticated account.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Resource not found message.","type":"string"}}}}}},"500":{"description":"Internal server error - an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Internal server error message.","type":"string","default":"An unexpected error occurred while processing the request."}}}}}}}}}}} ```` ## Export Subject Alerts > Generates and downloads an Excel file containing all active monitoring alerts for the specified subject.\ > \ > \*\*Important:\*\* The \`Accept\` header \*\*must\*\* be set to \`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\` to receive the file as a binary download. Without this header, the response body will be base64-encoded text instead of a valid Excel file.\ > \ > The response body is the \`.xlsx\` file itself. The \`Content-Disposition\` header provides the generated filename in the format: \`monitoring\_alerts\_subject\_{subject\_id}\_YYYYMMDD\_HHMMSS.xlsx\`.\ > \ > The subject must belong to the authenticated account. Returns 404 if the subject does not exist or belongs to a different account.\ > \ > The file is also stored on S3 and an \`ExportExcel\` audit record is created.\ > \ > \### Example curl\ > \ > \`\`\`\ > curl -X POST "" \\\ > -H "Authorization: Bearer \" \\\ > -H "Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" \\\ > -OJ\ > \`\`\`\ > \ > \### Example Request\ > \ > No request body is required. Send a \`POST\` with the \`Accept\` header set to \`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\`.\ > \ > \### Example Response\ > \ > The response body is a binary Excel (\`.xlsx\`) file. Key response headers:\ > \ > \`\`\`\ > Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\ > Content-Disposition: attachment; filename="monitoring\_alerts\_subject\_99\_20260115\_103000.xlsx"\ > Content-Length: 8192\ > X-Total-Records: 30\ > \`\`\`
````json {"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Monitoring Exports","description":"Export monitoring alerts as Excel files - account-wide, by group, or by subject."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/monitoring/subjects/{subject_id}/alerts/export":{"post":{"tags":["Monitoring Exports"],"operationId":"exportMonitoringSubjectAlerts","summary":"Export Subject Alerts","description":"Generates and downloads an Excel file containing all active monitoring alerts for the specified subject.\n\n**Important:** The `Accept` header **must** be set to `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` to receive the file as a binary download. Without this header, the response body will be base64-encoded text instead of a valid Excel file.\n\nThe response body is the `.xlsx` file itself. The `Content-Disposition` header provides the generated filename in the format: `monitoring_alerts_subject_{subject_id}_YYYYMMDD_HHMMSS.xlsx`.\n\nThe subject must belong to the authenticated account. Returns 404 if the subject does not exist or belongs to a different account.\n\nThe file is also stored on S3 and an `ExportExcel` audit record is created.\n\n### Example curl\n\n```\ncurl -X POST \"https://api-platform.vcheckglobal.net/v2/monitoring/subjects/{subject_id}/alerts/export\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\" \\\n -OJ\n```\n\n### Example Request\n\nNo request body is required. Send a `POST` with the `Accept` header set to `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`.\n\n### Example Response\n\nThe response body is a binary Excel (`.xlsx`) file. Key response headers:\n\n```\nContent-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\nContent-Disposition: attachment; filename=\"monitoring_alerts_subject_99_20260115_103000.xlsx\"\nContent-Length: 8192\nX-Total-Records: 30\n```\n","parameters":[{"name":"subject_id","in":"path","required":true,"description":"Unique monitoring subject identifier.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Excel file download. The response body is the `.xlsx` file itself.\n\n**Response headers:**\n- `Content-Disposition`: `attachment; filename=\".xlsx\"`\n- `Content-Length`: file size in bytes\n- `X-Total-Records`: number of alert records in the export\n\nThe file is also stored on S3 with a corresponding database audit record.\n\n### Export columns\n\nAlert ID, Subject Name, Subject Type, Group, Alert Type, Risk, Status, Alert Date, Agency, Category, Comments, Escalated, Created On, Updated On."},"403":{"description":"Forbidden - missing or invalid Client-ID credentials, insufficient scope, endpoint disabled via feature flag, or authenticated client has no linked account. Verify the scopes assigned to your credentials.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Authorization or access error message.","type":"string","default":"This endpoint is currently disabled."}}}}}},"404":{"description":"Not found - subject does not exist or does not belong to the authenticated account.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Resource not found message.","type":"string"}}}}}},"500":{"description":"Internal server error - an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Internal server error message.","type":"string","default":"An unexpected error occurred while processing the request."}}}}}}}}}}} ```` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.vcheckglobal.com/api-reference/monitoring/monitoring-exports.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.