API Method: /api/utility/help
Search the TwentyThree help center and API documentation.
Parameters
Parameter | Description |
---|---|
search | Search string. |
source | Limit results to a specific source, for example `api` for API documentation or `help` for Help Center. |
topic | Limit results to a certain topic, for example `analytics` or `upload`. |
include_content_p | Specifies whether or not to include the content of the help center article or not. |
Permission level
The minimum required permission level is:
none
Example XML Response
<response status="ok" permission_level="read" p="1" size="38" total_count="38" cached="0">
<help subject="Organizing your videos in channels" topic="Manage videos" source="help" index_date="2015-08-05 22:31:34.902309+02" url="https://www.23video.com/help/manage/organizing-your-videos-in-channels"/>
<help subject="Batch editing of videos" topic="Manage videos" source="help" index_date="2015-08-05 22:31:34.902309+02" url="https://www.23video.com/help/manage/batch-editing-videos"/>
<help subject="Using liquid with 23 Video " topic="Design sites and players" source="help" index_date="2015-08-05 22:31:34.902309+02" url="https://www.23video.com/help/design/using-liquid-with-23-video"/>
<help subject="Realtime API" topic="API Documentation" source="api" index_date="2015-08-05 22:31:35.326712+02" url="https://www.23video.com/api/realtime"/>
</response>
Example JSON Response
{
"status": "ok",
"permission_level":"read",
"cached":"0",
"help":[
{
"subject": "Batch editing of videos",
"topic": "Manage videos",
"source": "help",
"index_date": "2015-08-05 22:31:34.902309+02",
"url": "https://www.23video.com/help/manage/batch-editing-videos"
},
{
"subject": "Clip your videos",
"topic": "Manage videos",
"source": "help",
"index_date": "2015-08-05 22:31:34.902309+02",
"url": "https://www.23video.com/help/manage/clip"
}, ...],
"p": "1",
"size": "204",
"total_count": "204",
"site": {...},
"endpoint": "/api/utility/help"
}