Kaltura API DocumentationbaseEntry.exportToCsv

add batch job that sends an email with a link to download an updated CSV that contains list of entries

Try it out
post https://www.kaltura.com/api_v3/service/baseentry/action/exportToCsv

Request Parameters

body:object
object
additionalFields:array[object:KalturaCsvAdditionalFieldInfo]
object:KalturaCsvAdditionalFieldInfo
fieldName:string
xpath:string
filter:object:KalturaBaseEntryFilter
categoriesFullNameIn:string
categoryAncestorIdIn:string

All entries within this categoy or in child categories

conversionProfileIdEqual:integer
descriptionLike:string
excludedFreeTextGroups:string
freeText:string
isRoot:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]

Enum Type: KalturaNullableBoolean

objectType:string
Enum: KalturaBaseEntryFilter, KalturaPlayableEntryFilter, KalturaMediaEntryFilter, KalturaMediaEntryFilterForPlaylist, KalturaExternalMediaEntryFilter, KalturaLiveEntryFilter, KalturaLiveChannelFilter, KalturaLiveStreamEntryFilter, KalturaLiveStreamAdminEntryFilter, KalturaMixEntryFilter, KalturaDataEntryFilter, KalturaDocumentEntryFilter, KalturaPlaylistFilter
orderBy:string
Enum: CREATED_AT_ASC [+createdAt], END_DATE_ASC [+endDate], MODERATION_COUNT_ASC [+moderationCount], NAME_ASC [+name], PARTNER_SORT_VALUE_ASC [+partnerSortValue], RANK_ASC [+rank], RECENT_ASC [+recent], START_DATE_ASC [+startDate], TOTAL_RANK_ASC [+totalRank], UPDATED_AT_ASC [+updatedAt], WEIGHT_ASC [+weight], CREATED_AT_DESC [-createdAt], END_DATE_DESC [-endDate], MODERATION_COUNT_DESC [-moderationCount], NAME_DESC [-name], PARTNER_SORT_VALUE_DESC [-partnerSortValue], RANK_DESC [-rank], RECENT_DESC [-recent], START_DATE_DESC [-startDate], TOTAL_RANK_DESC [-totalRank], UPDATED_AT_DESC [-updatedAt], WEIGHT_DESC [-weight]
redirectFromEntryId:string

The id of the original entry

KalturaBaseEntryFilter must also match all of:
object:KalturaBaseEntryBaseFilter
mappedFields:array[object:KalturaKeyValue]
object:KalturaKeyValue

A key value pair representation to return an array of key-value pairs (associative array)

key:string
objectType:string
Enum: KalturaKeyValue, KalturaKeyValueExtended
value:string
KalturaKeyValue must also match any of:
object:KalturaKeyValueobject:KalturaKeyValueExtended
metadataProfileId:integer
options:object:KalturaExportToCsvOptions
defaultHeader:integer
Enum: NULL_VALUE [-1], FALSE_VALUE [0], TRUE_VALUE [1]

Enum Type: KalturaNullableBoolean

format:string

The format of the outputted date string. There are also several predefined date constants that may be used instead, so for example DATE_RSS contains the format string 'D, d M Y H:i:s'.

https://www.php.net/manual/en/function.date.php

typeEqual:string
Enum: AUTOMATIC [-1], CONFERENCE_ENTRY_SERVER [conference.CONFERENCE_ENTRY_SERVER], EXTERNAL_MEDIA [externalMedia.externalMedia], SIP_ENTRY_SERVER [sip.SIP_ENTRY_SERVER], MEDIA_CLIP [1], MIX [2], PLAYLIST [5], DATA [6], LIVE_STREAM [7], LIVE_CHANNEL [8], DOCUMENT [10]

Enum Type: KalturaEntryType

Setting this property will cause additional columns to be added to the final report. The columns will be related to the specific object type passed (currently only MEDIA_CLIP is supported).

Please note that this property will NOT change the result filter in any way (i.e passing MEDIA_CLIP here will not force the report to return only media items).

Response

Success

string