videos

List of videos

Query parameters

q - Free search query.

ordering - Order results by specified field. Prepend a minus for descending order. I.e. ?ordering=-id.

creator__email - the email of the video's creator

framerate - the framerate in hz * 1000

has_tono_records - if the tono flag is set (true/false)

is_filler - if this is a filler video (true/false)

name - the exact name/title of the video

name__icontains - substring is part of name/title of the video

organization - Frikanalen ID of organization behind video. Given alongside q, it also narrows the search to that organization's own videos: the organization's name stops counting as a match, since it would otherwise return the whole catalogue.

played_count_web - the number of times this video was played on the web

played_count_web__gt - greater than

played_count_web__gte - greater than or equal

played_count_web__lt - less than

played_count_web__lte - less than or equal

publish_on_web - if this video is published ont the web (true/false)

proper_import - whether ingest finished (true/false). Omitted, the list shows only finished videos, which is the public catalogue.

ref_url - the exact reference url

ref_url__startswith - the reference url start with this string

ref_url__icontains - the reference url contain this string

get/api/videos

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Authorization
    • API key in cookie sessionid

Query parameters

categories__name__icontainsstring[]
created_time_afterstring date-time
created_time_beforestring date-time
creator__emailstring
durationstring duration
duration__gtstring duration
duration__gtestring duration
duration__ltstring duration
duration__ltestring duration
framerateinteger
has_tono_recordsboolean
is_fillerboolean
limitinteger

Number of results to return per page.

namestring
name__icontainsstring
offsetinteger

The initial index from which to return the results.

orderingstring

Which field to use when ordering the results.

organizationinteger
played_count_webinteger
played_count_web__gtinteger
played_count_web__gteinteger
played_count_web__ltinteger
played_count_web__lteinteger
proper_importboolean

Whether ingest finished. Omitted means true.

publish_on_webboolean
qstring

Free-text search

ref_urlstring
ref_url__icontainsstring
ref_url__startswithstring
seriesinteger
updated_time_afterstring date-time
updated_time_beforestring date-time
uploaded_time_afterstring date-time
uploaded_time_beforestring date-time

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

    • info

      added the optional property /////// to the response with the status

    • breaking

      the response property // became optional for the status

    • info

      added the new optional query request parameter proper_import

    • info

      added the optional property // to the response with the status

    • info

      the response required property // became not read-only for the status