List forms and their submission counts

use Fetchski\AttractCmsLaravel\Facades\Attract;

$listSubmissionForms = Attract::formSubmissions()->listSubmissionForms();

{
  "forms": [
    {
      "aposDocId": "clx8k2m0a0007abcd1234efgh",
      "title": "Contact",
      "count": 42
    }
  ]
}

In your app

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

Add the controller

app/Http/Controllers/ListSubmissionFormsController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\ListSubmissionFormsResponse;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class ListSubmissionFormsController
{
    public function __invoke(): ListSubmissionFormsResponse
    {
        return Attract::formSubmissions()->listSubmissionForms();
    }
}

Add the route

routes/web.php

use App\Http\Controllers\ListSubmissionFormsController;
use Illuminate\Support\Facades\Route;

Route::get('/form-submission/forms', ListSubmissionFormsController::class);

Call it

Terminal

curl http://localhost:8000/form-submission/forms

With php artisan serve running, it prints its answer as JSON.

To keep the call in an Action instead, this writes app/Actions/Attract/ListSubmissionForms.php (an invokable Action that calls listSubmissionForms()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action formSubmissions.listSubmissionForms

Call it from the terminal

Terminal

php artisan attract:call formSubmissions.listSubmissionForms

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

Parameters

None: call it with no arguments.

Returns

A ListSubmissionFormsResponse (Fetchski\AttractCmsLaravel\Data\ListSubmissionFormsResponse). The forms. Read its properties ($listSubmissionForms->forms): each says whether the site always sends it.

Collection<int, FormSummary>

Always sent. A list of FormSummary.

Show FormSummary (Fetchski\AttractCmsLaravel\Data\FormSummary)

string

Always sent. Pass it as formId.

string

Always sent.

int

Always sent. Submissions stored for it.

Errors

Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).

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.

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/ListSubmissionFormsTest.php, then run your tests:

tests/Feature/ListSubmissionFormsTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class ListSubmissionFormsTest extends TestCase
{
    public function test_list_submission_forms(): void
    {
        Attract::fake();

        $this->getJson('/form-submission/forms')->assertOk();

        Attract::assertCalled('formSubmissions.listSubmissionForms');
    }
}

Terminal

php artisan test

List a form’s submissions

Attract::formSubmissions()->listFormSubmissions()

Export a form’s submissions as CSV

Attract::formSubmissions()->exportFormSubmissions()

GET /form-submission/forms

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

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

List forms and their submission counts

In your app

Call it from the terminal

Behavior

Test it

List a form’s submissions

Export a form’s submissions as CSV

GET /form-submission/forms

In your app

Call it from the terminal

Behavior

Test it

Related

List a form’s submissions

Export a form’s submissions as CSV

GET /form-submission/forms