Bulk Operations · recordBulk.summary
POST/bulk/summaryrecordBulk.summary
Summary records
POST /bulk/summary is part of the Bulk Operations group. Its parameters and response shape below are generated from the live OpenAPI document.
- Base URL
- https://api.power301.com/v1
- Auth
- Bearer token
- Idempotent
- No
- Returns
- application/json
The request
Send a JSON body to POST /bulk/summary. Every field is optional — send only what you want to set.
# Summary records
curl -X POST "https://api.power301.com/v1/bulk/summary?filter=value" \
-H "Authorization: Bearer $POWER301_TOKEN"Query parameters
| Parameter | Description |
|---|---|
| sortoptionalstring | Sort results by field. Prefix with - for descending order. Available sorts: id, created_at, updated_at, total_clicksid-idcreated_at-created_atupdated_at-updated_attotal_clicks-total_clicks |
| filterRequiredobject | Records the operation applies to. Accepted as a query object
(filter[host]=go.example.com) or as a filter object in the JSON body.
At least one filter must carry a value, or every record of the workspace would match.
Available filters: id, host, path, tld, handler, type, destination, search, tags, traffic, dns_correct, status, created_after, created_before |
| filter[id]optionalstring | |
| filter[host]optionalstring | |
| filter[path]optionalstring | |
| filter[tld]optionalstring | |
| filter[handler]optionalstring | |
| filter[type]optionalstring | |
| filter[destination]optionalstring | |
| filter[search]optionalstring | |
| filter[tags]optionalstring | |
| filter[traffic]optionalstring | |
| filter[dns_correct]optionalstring | |
| filter[status]optionalstring | |
| filter[created_after]optionalstring | |
| filter[created_before]optionalstring |
The response
A 200 returns the record as JSON.
{
"total": 1,
"by_kind": {
"link": 1,
"qr": 1,
"redirect": 1,
"migration": 1
},
"paused": 1,
"recent_traffic": {
"links": 1,
"visits": 1,
"weeks": 1,
"since": "string"
},
"changed": 1,
"sample": [
{
"id": "9f2a7c31-4b8e-4a02-9d1f-0c6b7e5a1d44",
"url": "https://go.acme.com/spring-sale",
"from": "string",
"to": "string"
}
]
}Status codes
200
SuccessWhat a bulk action on the filter would touch, for its confirmation: how many records, how many of each kind (
link, qr, redirect, migration), how many are paused, how many had clicks in the last four weeks (this week included) and how many visits that was. Works for a whole filter as well as filter[id]. Sent with the Destination dialog's destination_find / destination_replace or destination_params, it also previews that change: how many records it changed, and the first five with their from and to destination (to is null when the record stays the same).401
UnauthenticatedUnauthenticated
422
Validation failedA field was rejected.
errors lists every field with its reason.429
Too many requestsToo many requests
