Get User Videos
Get User Videos
Will return the list of your available video/s according to the filters applied - https://console.primis.tech/api/v1/videos/getVideos (POST)
Available response Fields Names:
- videoId
- videoTitle
- description
- width
- height
- duration
- thumbnailUrl
- orientation
- clickUrl
- language
- pubDate
- keyWords
- category
- guid
- scope
- channelId
- beginTime
- endTime
- iabCategories
- videoEmbedId
- videoPreviewUrl - specific page with a player (get embed code from request)
Optional filters
| Param | Sub Param | Format | Response | Notes |
|---|---|---|---|---|
| videoId/ channelId/ playlistId | Retrieves video/ channel/ playlist based on it’s id | Each time, only one of them can be filtered | ||
| filters | key Words | comma-separated | Retrieves a list of channels that includes any of this key word/s. | Based on OR (not AND). |
| language | comma-separated | Retrieves a list of channels that includes any of these language/s. | Based on OR (not AND). | |
| category | comma-separated | Retrieves a list of channels that includes any of these category/s. | Based on OR (not AND). | |
| orientation | horizontal/vertical/mixed | Default will return all types. | Based on “type” field. | |
| guid | string | will return only the specific video | ||
| pubDate(addTimestamp) | YYYY-MM-DD || YYYY-MM || YYYY | |||
| pagination | number | |||
| Number of items | number |
Filters example
To obtain all videos in English that contain the keyword "dog", the following filters should be applied: {“category”: “dog”, ”language”: “en”}
Get User Playlist
Will return the list of your available playlist/s according to the filters applied -https://console.primis.tech/api/v1/playlists/getPlaylists (POST)
Available response Fields Names:
- playlistId
- playlistName
- playlistLength
- extrenalContextualMathcing(Yes/No)
- orientation
- categories
- includeKeyWords
- excludeKeyWords
- languages
- playlistEmbedId
The API won’t display playlists with contextual matching.
Optional filters
| Param | Sub Param | Format | Response | Notes |
|---|---|---|---|---|
| playlistId | number | Retrieves a list of existing (active) playlists or playlist, based on it’s id | ||
| filters | includeKeyWords | comma-separated | Retrieves a list of playlists which includes any of these keyword/s | Based on OR (not AND) |
| excludeKeyWords | comma-separated | Retrieves a list of playlists which exclude any of these keyword/s | Based on OR (not AND) | |
| language | comma-separated | Retrieves a list of playlists which includes any of these language/s | Based on OR (not AND) | |
| category | comma-separated | Retrieves a list of playlists which includes any of these category/s | Based on OR (not AND) | |
| orientation | horizontal/vertical/mixed | Default will return all types | Based on the “type” field | |
| pagination | number | |||
| Number of items | number |
Filters specification
- All filter types assigned with “AND” logic
- Inactive/deleted playlists are filtered out as default
- There is no meaning to the filters parameters when a playlist id is specified
Filters example
To obtain all playlists that exclude the keyword "cars" with orientation "horizontal", the following filters should be applied: {“excludeKeyWords”: “cars”,”orientation”: “horizontal”}
Get User Channels
Will return the list of your available Channel/s according to the filters applied -https://console.primis.tech/api/v1/channels/getChannels (POST)
Available response Fields Names:
- channelId
- channelName
- scope
- categorykeyWords
- sourceUrl
- videoSourceType
- applicableForContexualMatching
- language
- captions
- pubDate
- orientationContributorName
- domainsFilter
- geosFilter
- duration
- totalVideos
- lastModifiedDate
- views
- geosList
Optional filters
| Param | Sub Param | Format | Response | Notes |
|---|---|---|---|---|
| channelId | number | Retrieves a list of existing (active) channels or channel, based on it’s id | ||
| filters | key Words | comma-separated | Retrieves a list of channels which includes any of this key word/s. | Based on OR (not AND) |
| language | comma-separated | Retrieves a list of channels which includes any of this language/s. | Based on OR (not AND) | |
| category | comma-separated | Retrieves a list of channels which includes any of this category/s. | Based on OR (not AND) | |
| orientation | horizontal/vertical/mixed | Default will return all types. | Based on the “type” field | |
| pubDate(addTimestamp) | YYYY-MM-DD || YYYY-MM || YYYY | |||
| lastModifiedDate | YYYY-MM-DD || YYYY-MM || YYYY | This is generated field |
Filters specification:
- All filter types assigned with “AND” logic
- Inactive/deleted channels are filtered out as default
Filters example
In order to obtain all channels containing the keywords "food" with orientation "mixed", the following filters should be applied: {“includeKeyWords”: “food”,”orientation”: “mixed”}
Updated 4 days ago