Playlist imports

List playlist imports

GET/streams/m3u-imports/

read Read: looks, changes nothing. Scopes

Imports newest first, a page at a time: the caller's own, or every one for an account that sees the whole catalogue.

Query parameters

  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Part of the file name.

  • statusstring

    One or more of parsing, parsed, running, starting, completed, failed, cancelled, separated by commas.

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]required
    • idstring (uuid)requiredread-only
    • filenamestringrequiredread-only
    • statusstringrequiredread-only
    • group_summaryanyrequiredread-only

      [[group-title, channel count], …] as parsed from the upload.

    • selected_groupsanyrequiredread-only
    • optionsanyrequiredread-only

      The settings applied to every stream this import creates.

    • totalintegerrequiredread-only
    • createdintegerrequiredread-only
    • updatedintegerrequiredread-only
    • skippedintegerrequiredread-only
    • failed_countintegerrequiredread-only
    • started_countintegerrequiredread-only
    • total_channelsintegerrequiredread-only

      Channels in the playlist, before any group is left out.

    • processedintegerrequiredread-only

      Channels dealt with so far, whatever was done with them.

    • start_totalintegerrequiredread-only

      Streams waiting to be started a few at a time; started_count of them have started.

    • is_finishedbooleanrequiredread-only
    • messagestringrequiredread-only
    • warningsanyrequiredread-only
    • streams_countintegerrequiredread-only

      Streams that still carry this import's stamp — created or updated by it, and not deleted since.

    • created_by_usernamestringrequiredread-only
    • created_atstring (date-time)requiredread-only
    • updated_atstring (date-time)requiredread-only

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means