marketing

Scan a website

Read a public website and keep what it found — the pages, the words and the pictures — as a versioned manifest a marketing video can be built from. Scanning costs no video time; the EXPORT is what charges. Answers 202 with a Location pointing at the source; poll it until state is terminal, then marketing.generations.create to turn it into a project. One scan at a time per account.

post/marketing/sources

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/marketing/sources
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Request body

demoobject

A demo account to sign in with, so the scan can see pages behind a login: { loginUrl, username, password, targetUrls[] }. Encrypted at rest and deleted after the scan.

urlstring required

The website to read. Public addresses only.

Response

The work was already known — the service recognised this key on its own record and queued nothing new. Answered when the 24-hour idempotency claim has expired but the work has not.

createdboolean required
dispatchedboolean required

Whether the job has started. False means it is accepted and will start shortly; it is not a failure.

operationIdstring required

The scan attempt. Poll the SOURCE, not this: a source has many scans and one current manifest.

resourceobject required

Changes

No recorded changes to this operation across all 1 revision of this API.