Skip to main content

In your app

A controller answers a route on your app: it calls listFormSubmissions() and returns the answer.

Add the controller

app/Http/Controllers/ListFormSubmissionsController.php
The other values are the example’s: take yours from the request, a form or your database.

Add the route

routes/web.php

Call it

Terminal
With php artisan serve running, it prints its answer as JSON.
To keep the call in an Action instead, this writes app/Actions/Attract/ListFormSubmissions.php (an invokable Action that calls listFormSubmissions()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):
Terminal

Call it from the terminal

Terminal
It calls listFormSubmissions() on your default site and prints its answer as JSON. See Call any method from the terminal for every argument type.

Required parameters

Named arguments, e.g. listFormSubmissions(formId: …); leave out the optional ones.
string
required
Required. The form: its document ID, in either form (<aposDocId> or <aposDocId>:<locale>:<mode>), from the forms list.
?int
Optional. Leave it out and the site uses 1. Page number, from 1 (a page past the end answers the last page).
?int
Optional. Leave it out and the site uses 25. Submissions per page. 1 to 100.
A FormSubmissionPage (Fetchski\AttractCmsLaravel\Data\FormSubmissionPage). A page of submissions. Read its properties ($formSubmissionPage->submissions): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (_id → id).
Collection<int, FormSubmission>
Always sent. A list of FormSubmission.
Collection<int, FormSubmissionColumn>
Always sent. A list of FormSubmissionColumn. Every data key seen in the form’s recent submissions, in first-seen order: stable from page to page.
int
Always sent.
int
Always sent.
int
Always sent.
int
Always sent. At least 1.
Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (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
Attract::site('acme') named a slug that isn’t under sites in config/fetchski-attract.php.Retried first: No: nothing was sent. Read: getMessage(), $e->slug.
setup
The site’s config entry is wrong: no url, a malformed api_key, a key filed under another slug, or no default site.Retried first: No: nothing was sent. Read: getMessage() (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 in config/fetchski-attract.php for longer.
  • Paging: one page per call. To walk them all, use listFormSubmissionsAll() (see More examples): it asks for the next page as you iterate, and stops after page totalPages.

More examples

listFormSubmissionsAll() takes listFormSubmissions()’s arguments except page.

Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as tests/Feature/ListFormSubmissionsTest.php, then run your tests:
tests/Feature/ListFormSubmissionsTest.php
Terminal
Answer with your own values: fake formSubmissions.listFormSubmissions with a sequence() of pages, each FormSubmissionPage::factory()->make([...]), and walk listFormSubmissionsAll().
tests/Feature/ListFormSubmissionsAnswerTest.php
To fake listFormSubmissionsAll(), answer formSubmissions.listFormSubmissions (the walk calls it page by page): a sequence() of answers for several pages.

List forms and their submission counts

Attract::formSubmissions()->listSubmissionForms()

Export a form’s submissions as CSV

Attract::formSubmissions()->exportFormSubmissions()

GET /form-submission/list

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