In your app
A controller answers a route on your app: it callslistFormSubmissions() and returns the answer.
Add the controller
app/Http/Controllers/ListFormSubmissionsController.php
Add the route
routes/web.php
Call it
Terminal
php artisan serve running, it prints its answer as JSON.Call it from the terminal
Terminal
listFormSubmissions() on your default site and prints its answer as JSON. See Call any method from the terminal for every argument type.
Required parameters
Required parameters
Optional parameters
Optional parameters
Returns
Returns
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).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.Errors
Errors
Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).
The request is not valid; the message says which part and how to fix it.Retried first: No. Read:
errors() (field → messages), siteMessage().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().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().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().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().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: 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().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 status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read:
reason(), status().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.Behavior
- Access: an API key with
forms:read, orforms:all, oradmin:all, or a signed-in user holding theform-submissions:viewpermission. 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 seeRateLimitedonly 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
timeoutinconfig/fetchski-attract.phpfor 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 pagetotalPages.
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 astests/Feature/ListFormSubmissionsTest.php, then run your tests:
tests/Feature/ListFormSubmissionsTest.php
Terminal
formSubmissions.listFormSubmissions with a sequence() of pages, each FormSubmissionPage::factory()->make([...]), and walk listFormSubmissionsAll().
tests/Feature/ListFormSubmissionsAnswerTest.php
listFormSubmissionsAll(), answer formSubmissions.listFormSubmissions (the walk calls it page by page): a sequence() of answers for several pages.
Related
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.