List videos

use Fetchski\AttractCmsLaravel\Facades\Attract;

$listMediaVideos = Attract::fetchskiMedia()->listMediaVideos();

{
  "results": [
    {
      "_id": "clx8k2m0a0002abcd1234efgh",
      "slug": "video-product-tour",
      "title": "Product tour",
      "folderPath": "Marketing",
      "extension": "mp4",
      "bytes": 18430211,
      "url": "https://cdn.example.com/attachments/def456-product-tour.mp4",
      "poster": "https://cdn.example.com/attachments/ghi789-tour-poster.full.jpg"
    }
  ],
  "page": 1,
  "perPage": 25,
  "total": 1
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$listMediaVideos = Attract::fetchskiMedia()->listMediaVideos();

{
  "results": [
    {
      "_id": "clx8k2m0a0002abcd1234efgh",
      "slug": "video-product-tour",
      "title": "Product tour",
      "folderPath": "Marketing",
      "extension": "mp4",
      "bytes": 18430211,
      "url": "https://cdn.example.com/attachments/def456-product-tour.mp4",
      "poster": "https://cdn.example.com/attachments/ghi789-tour-poster.full.jpg"
    }
  ],
  "page": 1,
  "perPage": 25,
  "total": 1
}

In your app

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

Add the controller

app/Http/Controllers/ListMediaVideosController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ListMediaVideosController
{
    public function __invoke(): ListMediaVideosResponse
    {
        return Attract::fetchskiMedia()->listMediaVideos();
    }
}

Add the route

routes/web.php

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

Route::get('/fetchski-media/videos', ListMediaVideosController::class);

Call it

Terminal

curl http://localhost:8000/fetchski-media/videos

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

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

Terminal

php artisan make:attract-action fetchskiMedia.listMediaVideos

Call it from the terminal

Terminal

php artisan attract:call fetchskiMedia.listMediaVideos

It calls listMediaVideos() on your default site and prints its answer as JSON. See Call any method from the terminal for every argument type. Use a video’s slug to reference it in an MDX blog import.

Optional parameters

Named arguments, e.g. listMediaVideos(q: …); leave out the optional ones.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Words matched against each video’s title, alt text and other text: any of the words matches, best match first.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. A media folder ID: only what is in that folder.

?bool

Optional. Leave it out and the site uses true. With folder: include its subfolders too.

?int

Optional. Leave it out and the site uses 25. Items per page: 1 to 100, 25 when left out (a value outside is brought into that range, never refused).

?int

Optional. Leave it out and the site uses 1. Page number, from 1.

Returns

A ListMediaVideosResponse (Fetchski\AttractCmsLaravel\Data\ListMediaVideosResponse). A page of videos. Read its properties ($listMediaVideos->results): 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, MediaVideo>

Always sent. A list of MediaVideo.

Show MediaVideo (Fetchski\AttractCmsLaravel\Data\MediaVideo)

One video from the Videos library.

?string

Always sent, can be null. The video’s document ID (aposDocId).

?string

Always sent, can be null. Reference a video in an MDX import by it.

?string

Always sent, can be null. Its title.

?string

Always sent, can be null. The media folder it sits in.

?string

Always sent, can be null. File extension, e.g. mp4.

?int

Always sent, can be null. Size of the file.

?string

Always sent, can be null. The video file.

?string

Always sent, can be null. The poster image, when one is set.

int

Always sent.

int

Always sent.

int

Always sent. Every match, across all pages.

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, is used from outside its allowlist, or the caller is anonymous.Retried first: No. Read: siteMessage(), errorName(), data().

429

The key used up its reads-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 videos:read — or media:all, or admin:all — or any signed-in CMS user (who sees only what they may view). Anonymous callers get 403.
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 listMediaVideosAll() (see More examples): it asks for the next page as you iterate, and stops once page × perPage reaches total.

More examples

listMediaVideosAll() takes listMediaVideos()’s arguments except page.

use Fetchski\AttractCmsLaravel\Facades\Attract;

$mediaVideos = Attract::fetchskiMedia()->listMediaVideosAll(); // LazyCollection<int, MediaVideo>: the next page is fetched as you iterate

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

tests/Feature/ListMediaVideosTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListMediaVideosTest extends TestCase
{
    public function test_list_media_videos(): void
    {
        Attract::fake();

        $this->getJson('/fetchski-media/videos')->assertOk();

        Attract::assertCalled('fetchskiMedia.listMediaVideos');
    }
}

Terminal

php artisan test

Answer with your own values: fake fetchskiMedia.listMediaVideos with a sequence() of pages, each ListMediaVideosResponse::factory()->make([...]), and walk listMediaVideosAll().

tests/Feature/ListMediaVideosAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListMediaVideosAnswerTest extends TestCase
{
    public function test_list_media_videos_answers_your_values(): void
    {
        Attract::fake([
            'fetchskiMedia.listMediaVideos' => Attract::sequence(
                ListMediaVideosResponse::factory()->make(['page' => 1, 'perPage' => 1, 'total' => 2]),
                ListMediaVideosResponse::factory()->make(['page' => 2, 'perPage' => 1, 'total' => 2]),
            ),
        ]);

        $mediaVideos = Attract::fetchskiMedia()->listMediaVideosAll();

        $this->assertCount(2, $mediaVideos->all());
    }
}

To fake listMediaVideosAll(), answer fetchskiMedia.listMediaVideos (the walk calls it page by page): a sequence() of answers for several pages.

List images

Attract::fetchskiMedia()->listMediaImages()

Get one image

Attract::fetchskiMedia()->getMediaImage()

Get one video

Attract::fetchskiMedia()->getMediaVideo()

GET /fetchski-media/videos

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$listMediaVideos = Attract::fetchskiMedia()->listMediaVideos();

{
  "results": [
    {
      "_id": "clx8k2m0a0002abcd1234efgh",
      "slug": "video-product-tour",
      "title": "Product tour",
      "folderPath": "Marketing",
      "extension": "mp4",
      "bytes": 18430211,
      "url": "https://cdn.example.com/attachments/def456-product-tour.mp4",
      "poster": "https://cdn.example.com/attachments/ghi789-tour-poster.full.jpg"
    }
  ],
  "page": 1,
  "perPage": 25,
  "total": 1
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Behavior

More examples

Test it

List images

Get one image

Get one video

GET /fetchski-media/videos

In your app

Call it from the terminal

Behavior

More examples

Test it

Related

List images

Get one image

Get one video

GET /fetchski-media/videos