marketing.exports.get

One marketing export

GET/marketing/exports/{id}

Operation: marketing.exports.get
MCP tool: marketing_exports_get

What an export is doing, what it cost in seconds, and which sidecars it produced (cover image, captions, approved transcript). A succeeded export whose files were deleted at the end of the retention period still reads succeeded, with failureCode: "expired" — the outcome stands, the download is gone.

curl -X GET "https://api.gogoscreen.com/api/v1/marketing/exports/<id>" \
  -H "Authorization: Bearer $GOGOSCREEN_API_KEY"

A request to this operation.

At a glance

Fact	Detail
Scopes	`marketing:read`
Credentials	a signed in dashboard session or an API key.
Rate limit	600 requests a minute per credential, in the `read` class.
Idempotency	Not applicable. This operation changes nothing.
MCP tool	`marketing_exports_get`
Always sets	`Cache-Control: private, no-store`
Verified email	Required. An account whose email address is not verified meets `403 email_unverified` before the operation runs.

Path parameters

Name	Type	Required	Description
id	string	Required	The resource `id`, from a create answer or the matching list.format: uuid

Response

Answers 200. Every answer also carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset, and every error body carries a requestId.

200 OK

One marketing export

Name Type Description

credit object | null The music credit this export's bed owes, when it plays one. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.any keys

export object

22 fields inside export

Name	Type	Description
audioMode	string
durationSeconds	number
failureCode	string \| null
format	string
hasCaptions	boolean
hasCover	boolean
hasTranscript	boolean
id	string
progress	object \| null	The last progress reading while the export runs: the current step and a whole percent. null once it has settled, and null when no reading was recorded.
at	string \| null
percent	integer	0–100
stage	string
projectId	string
qa	object \| null	The outcome of the automated checks, once they have run; null before. Why an export failed is `failureCode`.
notes	string[]	What the export did that a person may want to know, as codes: `font_missing`, `cover_drawn`, `cover_not_drawn`, `narration_fitted`, `transcript_written`, `transcript_not_written`. A note is not a failure.
ok	boolean	Whether the automated checks on the finished file passed.
revisionId	string
secondsCharged	number \| null
secondsReserved	number
state	string	one of: queued, running, succeeded, failed, cancelled
status	string
watermark	string

200 OK headers
Header	Meaning
`Cache-Control`	Always `private, no-store`.

Errors

Every refusal is { error: { code, message, details?, requestId } }. Branch on code, never on the sentence. The full catalogue is at Errors.

Code	Status	When it happens	What to do
validation_failed	400	The merged path, query and body did not match the operation's schema. The schemas are strict, so an unknown field is a failure rather than something ignored, and a string carrying half of a character is refused before it can be stored.	Read `details.issues`. Each entry carries a `path`, a `message` and a machine readable `code`. Fix every named field and send the request again; the same body always fails the same way.
unauthorized	401	No credential was presented, or the key is unknown, revoked or expired, or an `X-API-Key` header carried something that is not an API key. `details.reason` says which.	Send `Authorization: Bearer gsk_live_…`. A revoked or expired key never starts working again, so issue a new one in the developer console. Put a dashboard session token in `Authorization`, never in `X-API-Key`.
forbidden_scope	403	The credential does not carry every scope the operation declares, or it is the wrong kind of credential for it. `keys.` and `assistant.` are user only and can never be called by a key.	`details.requiredScopes` and `details.missingScopes` name what is missing. A key's scopes cannot be changed after it is issued, so create a new key with them. When `details.allowedActors` is present, no key can call this operation at all.
not_found	404	No resource of that id belongs to this account. A resource that belongs to somebody else answers 404 as well, never 403.	Check the id. Do not treat this as a permissions problem.
rate_limited	429	The credential's per minute budget, the account's per minute ceiling, or a daily cap was exceeded. `details.scope` is `minute`, `day` or `account`, or `global` when the product's own daily cap on voice previews is spent.	Wait the `Retry-After` seconds and retry. `details.limit` and `details.resetAt` say what was hit and when it reopens. The `RateLimit-*` headers on every answer let a client pace itself before it gets here.
internal_error	500	An unhandled failure inside this API. The original message is logged and never answered.	Retry once, then quote `requestId` to support. A 5xx deletes the idempotency claim rather than storing it, so retrying under the same key is safe.