API Reference / Proxy remediations
Summarise proxy repairs
Returns the figures of the repairs in your workspace whose problem was found in a period, optionally narrowed by pool: how many were found and how they stand (fixed, stopped, waiting, in progress), how many accounts they touched, the average time from problem found to fixed, and how the fixed ones ended.
/ proxies. v1. Proxies/ GetRemediationSummaryRequest body
application/jsonRequired
Request for the figures of the repairs in the caller's workspace, usually over a period.
filter?RemediationFilterThe same filter as ListRemediations. Created_from and created_before set the period by when each problem was found.
Show attributes
createdBefore?stringOptional end of a period, exclusive: only repairs whose problem was found before this instant. Unset does not restrict.
Format"date-time"
createdFrom?stringOptional start of a period, inclusive: only repairs whose problem was found at or after this instant. Unset does not restrict.
Format"date-time"
poolId?stringOptional pool id to limit results to that pool's remediation records. Unset includes remediation records across all pools.
Format"byte" base64
Response body
application/json
Success
accountCount?integerNumber of distinct accounts with at least one repair in the period.
Format"int32"
averageRepairDuration?stringAverage of completed_at minus created_at over the fixed repairs. Absent when none is fixed.
fixedCount?integerRepairs that finished: status done.
Format"int32"
foundCount?integerNumber of repairs whose problem was found in the period. Equals fixed_count + stopped_count + waiting_count + in_progress_count.
Format"int32"
inProgressCount?integerEvery other unfinished repair.
Format"int32"
outcomeCounts?array<RemediationOutcomeCount>The fixed repairs by how they ended, adding up to fixed_count. Unset counts repairs finished before outcomes were recorded. Outcomes with no repairs are left out.
Show attributes
count?integerNumber of fixed repairs with this outcome.
Format"int32"
outcome?stringThe outcome this count is for.
Value in"REMEDIATION_"REMEDIATION_"REMEDIATION_"REMEDIATION_
stoppedCount?integerRepairs that stopped and need attention: status halted.
Format"int32"
waitingCount?integerRepairs that need a new endpoint and are waiting, with a waiting reason.
Format"int32"
application/json
The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request was rate limited. Slow down and retry later.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The service is temporarily unavailable. Retry with backoff.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
curl -X POST "https://api.goldmine.to/proxies.v1.Proxies/GetRemediationSummary" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filter": {
"createdFrom": "2026-06-22T00:00:00Z",
"createdBefore": "2026-06-29T00:00:00Z"
}
}'const res = await fetch("https://api.goldmine.to/proxies.v1.Proxies/GetRemediationSummary", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"filter": {
"createdFrom": "2026-06-22T00:00:00Z",
"createdBefore": "2026-06-29T00:00:00Z"
}
}),
});
const data = await res.json();body := strings.NewReader(`{
"filter": {
"createdFrom": "2026-06-22T00:00:00Z",
"createdBefore": "2026-06-29T00:00:00Z"
}
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/proxies.v1.Proxies/GetRemediationSummary", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/proxies.v1.Proxies/GetRemediationSummary",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"filter": {
"createdFrom": "2026-06-22T00:00:00Z",
"createdBefore": "2026-06-29T00:00:00Z"
}
},
)
data = res.json(){
"foundCount": 5,
"fixedCount": 3,
"stoppedCount": 1,
"waitingCount": 1,
"inProgressCount": 0,
"accountCount": 4,
"averageRepairDuration": "540s",
"outcomeCounts": [
{
"outcome": "REMEDIATION_OUTCOME_BOUGHT",
"count": 2
},
{
"outcome": "REMEDIATION_OUTCOME_REPLACED",
"count": 1
}
]
}{
"code": "failed_precondition",
"message": "The request cannot be carried out in the current system state."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}{
"code": "unavailable",
"message": "The service is temporarily unavailable. Retry with backoff."
}