Skip to main content

In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

Add the function

src/attract/export-form-submissions.ts
The other values are the example’s: take yours from the request, a form or your database.

Call it

A script makes the client once and calls the function:
scripts/export-form-submissions.ts
Terminal
A route handler, a job or a queue worker calls it the same way.
A signed-in user also needs the form-submissions:export permission: one holding only form-submissions:view gets 403 (data.permission names it).

Required parameters

One object, e.g. exportFormSubmissions({ formId }); leave out the optional fields.
string
required
Required. The form: its document ID, in either form (<aposDocId> or <aposDocId>:<locale>:<mode>), from the forms list.
A FormSubmissionExport. The CSV. Read its properties (formSubmissionExport.filename): each says whether the site always sends it.
string
Always sent.
string
Always sent. The CSV (UTF-8 with a byte-order mark, CRLF lines): Submitted, Visitor ID (only when a row has one), then every field. A cell starting =, +, -, @ or a tab is prefixed with ' so a spreadsheet never runs it.
number
Always sent. Rows in csv.
number
Always sent. Submissions the form has.
boolean
Always sent. True when rows < total: the newest 10,000 only.
Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see Errors and testing).
400
The request is not valid; the message says which part and how to fix it.Retried first: No. Read: errors (field → messages), siteMessage.
401
The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.Retried first: No. Read: siteMessage, errorName, data.
403
The API key lacks the scope this route needs (the message names it) or is used from outside its allowlist; or, on a route that answers 403 to everyone it refuses, the caller may not use it.Retried first: No. Read: siteMessage, errorName, data.
404
Nothing matches the identifier, or the caller may not use this route at all (it is not advertised).Retried first: No. Read: siteMessage, errorName, data.
429
The key used up its per-minute limit. Still, after the client’s own waits and retries.Retried first: Yes: the client waits Retry-After (1 s when absent; over 60 s it gives up at once) and retries, up to retries times (2 by default). Read: retryAfter (seconds, or null), siteMessage.
5xx
The site failed (or something in front of it did). Its logs say why.Retried first: A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. Read: siteMessage, errorName, data.
no answer
No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read: reason, neverConnected.
not sent
The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason (what to change).
any other
Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason, status.
setup
sites.forSite('acme') named a slug your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.
setup
The client’s settings are wrong: no FETCHSKI_ATTRACT_URL (or baseUrl), or a malformed API key.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

  • Access: an API key with forms:read, or forms:all, or admin:all, or a signed-in user holding the form-submissions:view permission. Other callers get 404.
  • Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
  • Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
  • Timeout: 15 s per attempt by default; raise timeout (milliseconds) on the client for longer.

Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with node --test.
tests/formSubmissions-exportFormSubmissions.test.ts
Answer with your own values: fake formSubmissions.exportFormSubmissions with factories.FormSubmissionExport({...}), the fields you give over a valid example.
tests/formSubmissions-exportFormSubmissions-answer.test.ts

List forms and their submission counts

site.formSubmissions().listSubmissionForms()

List a form’s submissions

site.formSubmissions().listFormSubmissions()

GET /form-submission/export

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.