Get Embed's Feed
This endpoint retrieves the embed's feed witch contains Feed that has an Embed as associated media.
info
If the tuple embed_type
embed_id
is passed as parameter retrieves a list
of Feed that has Embed as associated media
like the Get a specific Embed's Feed API.
info
This operation requires authentication only if content_availability
community option is false
HTTP Request
GET /api/v2/embed/feed/
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
embed_type | query | string | false | The embed type |
embed_id | query | string | false | The embed id |
metadata | query | json dict | false | A json dict containing some TERM_KEYS (eg: {"authors": ["Umberto Eco", "Neil Gaiman"], "type": "book"}) |
limit | query | integer | false | Number of results to return per page |
offset | query | integer | false | The initial index from which to return the results |
ordering | query | string | false | The ordering of the feed. Default to 'recent' |
Enumerated Values
Parameter | Value | Description |
---|---|---|
» ordering | recent | Order by recent creation datetime |
» ordering | last_activity | Order by last activity in the Feed object |
Example Request
- JavaScript
- Bash
const headers = {
'Accept':'application/json',
'Authorization': 'Bearer {access_token}'
};
fetch('/api/v2/embed/feed/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET /api/v2/embed/feed/ \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access_token}'
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response status code | Inline |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» count | integer | false | none | Total results count |
» next | string(uri)¦null | false | none | Next page url |
» previous | string(uri)¦null | false | none | Previous page url |
» results | list(Feed) | false | none | List of results |
Example responses
- 200
{
"count": "integer",
"next": "string(uri)",
"previous": "string(uri)",
"results": [
{
"type": "string",
"discussion": {
"id": "integer",
"type": "string",
"last_activity_at": "string",
"author": {User},
"added_at": "string",
"last_edited_at": "string",
"html": "string",
"summary": "string",
"deleted": "boolean",
"collapsed": "boolean",
"comment_count": "integer",
"view_count": "integer",
"vote_count": "integer",
"reactions_count": [{Reaction}],
"voted": "boolean",
"reaction": {Reaction},
"follower_count": "integer",
"followed": "boolean",
"suspended": "boolean",
"flag_count": "integer",
"share_count": "integer",
"slug": "string",
"categories": [{Category}],
"medias": [{Media}],
"location": "string",
"addressing": ["integer"],
"tags": ["integer"],
"poll": {Poll},
"title": "string"
}
}
]
}