Sign in
OTel

Quote a bulk Cloud-telemetry activation. Sends nothing.

Changed on
post/otel/cloud-telemetry/bulk-jobs/estimate

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/otel/cloud-telemetry/bulk-jobs/estimate
  • Auth: HTTP bearer

Request body

all_eligible_projectsboolean

Quote every project that still writes its spans to this instance.

project_idsinteger[] nullable

Quote exactly these projects. Projects that are already Cloud-primary are accepted here — re-shipping a window is the retry path — but are never picked up by all_eligible_projects.

window_fromstring date-time nullable

Start of the window to ship. Defaults to the oldest span local retention can still be holding.

window_tostring date-time nullable

End of the window to ship. Defaults to now.

Response

Per-project and total estimate, plus a plan token

active_batch_idstring nullable

A job already running. Submitting would be refused with 409, so the client can offer "watch the running job" instead of a button that fails.

configuredboolean required

Whether a bulk activation could run at all right now.

false is the normal state on an unlinked instance and must render as onboarding, not as an error.

eligible_projectsinteger required
estimated_bytesinteger required
estimated_spansinteger required

Totals over the eligible projects only — what confirming this quote would actually send.

plan_expires_atstring date-time nullable
plan_hashstring nullable

Stable identity of the project set and windows, recorded on the job.

plan_tokenstring nullable

The handle to send back to POST /bulk-jobs.

None when nothing is eligible: there is no bill to confirm, and handing back a token that would be refused on submit would be a dead end with no explanation attached.

reasonstring nullable
setup_pathstring nullable
skipped_projectsinteger required
total_projectsinteger required
window_fromstring date-time required
window_tostring date-time required

Changes

  • 4b228ebed583Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status