Skip to content
calternal docs

Tag progress

GET
/api/v1/tags/rewrites/{id}
curl --request GET \
  --url https://example.com/api/v1/tags/rewrites/example \
  --header 'Authorization: Bearer <token>'

Read progress for your Tag operation. Route: /api/v1/tags/rewrites/{id}. Inputs: id. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Source text stays private in Home journals; clients receive only progress.

object
can_undo
required
boolean
conflicts
required
integer
current
integer | null format: int64
id
required
string
state
required
string
total
integer | null format: int64
Examplegenerated
{
  "can_undo": true,
  "conflicts": 1,
  "current": 1,
  "id": "example",
  "state": "example",
  "total": 1
}

404

Section titled “404”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}