List videos

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const listMediaVideos = await site.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
}

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const listMediaVideos = await site.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 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/list-media-videos.ts

import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function listMediaVideos(site: SiteClient) {
  return site.fetchskiMedia().listMediaVideos();
}

Call it

A script makes the client once and calls the function:

scripts/list-media-videos.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { listMediaVideos } from '../src/attract/list-media-videos.ts';

const site = createSiteClient();
console.log(await listMediaVideos(site));

Terminal

node --env-file=.env scripts/list-media-videos.ts

A route handler, a job or a queue worker calls it the same way.

Use a video’s slug to reference it in an MDX blog import.

Optional parameters

One object, e.g. listMediaVideos({ q }); leave out the optional fields.

string | null | undefined

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 | null | undefined

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.

boolean | null | undefined

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

number | null | undefined

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).

number | null | undefined

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

Returns

A 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).

readonly MediaVideo[]

Always sent. A list of MediaVideo.

Show MediaVideo

One video from the Videos library.

string | null

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

string | null

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

string | null

Always sent, can be null. Its title.

string | null

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

string | null

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

number | null

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

string | null

Always sent, can be null. The video file.

string | null

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

number

Always sent.

number

Always sent.

number

Always sent. Every match, across all pages.

Errors

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).

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

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 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 (milliseconds) on the client 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.

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
for await (const mediaVideo of site.fetchskiMedia().listMediaVideosAll()) {
  console.log(mediaVideo); // the next page is fetched as you iterate
}

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/fetchskiMedia-listMediaVideos.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { listMediaVideos } from '../src/attract/list-media-videos.ts';

test('fetchskiMedia.listMediaVideos', async () => {
  const site = fakeSite();
  await listMediaVideos(site);
  site.assertCalled('fetchskiMedia.listMediaVideos');
});

Answer with your own values: fake fetchskiMedia.listMediaVideos with a sequence() of pages, each factories.ListMediaVideosResponse({...}), and walk listMediaVideosAll().

tests/fetchskiMedia-listMediaVideos-answer.test.ts

import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite, sequence } from '@fetchski/attract-cms-sdk/testing';

test('fetchskiMedia.listMediaVideos answers your values', async () => {
  const site = fakeSite({
    'fetchskiMedia.listMediaVideos': sequence(
      factories.ListMediaVideosResponse({ page: 1, perPage: 1, total: 2 }),
      factories.ListMediaVideosResponse({ page: 2, perPage: 1, total: 2 })
    )
  });
  const walked: unknown[] = [];
  for await (const mediaVideo of site.fetchskiMedia().listMediaVideosAll()) {
    walked.push(mediaVideo);
  }
  assert.equal(walked.length, 2);
});

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

List images

site.fetchskiMedia().listMediaImages()

Get one image

site.fetchskiMedia().getMediaImage()

Get one video

site.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.

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const listMediaVideos = await site.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

Behavior

More examples

Test it

List images

Get one image

Get one video

GET /fetchski-media/videos

In your app

Behavior

More examples

Test it

Related

List images

Get one image

Get one video

GET /fetchski-media/videos