GET accounts/:account_id/cards/video_conversation¶
Retrieve information about video conversation cards for a given account.
Resource URL¶
https://ads-api.twitter.com/1/accounts/:account_id/cards/video_conversation
Resource Information¶
| Response formats | JSON |
| Requires authentication? | Yes (user context only) |
| Rate limited? | Yes |
Parameters¶
| Name | Required | Description | Default Value | Example |
| account_id | required | The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertising API requests excluding GET accounts . The specified account must be associated with the authenticating user. | 43853bhii879 | |
| card_ids | optional | Include specific cards in your request. | xyz1 | |
| with_deleted | optional | Include deleted results in your request. Defaults to false . | true | |
| count | optional | Specifies the number of records to try and retrieve, up to a maximum of 1000 per distinct request. | ||
| cursor | optional | Specifies a cursor to get the next page of results. See Pagination for more information. | gc-ddf4a | |
| sort_by | optional | Sorts by supported attribute in ascending or descending order. See Sorting for more information. | created_at-asc updated_at-desc |
Example Request¶
GET https://ads-api.twitter.com/1/accounts/abc1/cards/video_conversation
Example Response¶
{
"total_count": 1,
"data": [
{
"name": "video conversation card",
"title": "Want your voice heard?",
"first_cta": "#ShoutItOut",
"first_cta_tweet": "I #Heart @AdsAPI!",
"video_url": "https://amp.twimg.com/prod/multibr_v_1/vmap/2015/10/06/18/059fb019-b532-4d9b-a019-b8b992a59dde/3199071a-ade5-4e51-8ce1-6b6ea55b5463.vmap",
"content_duration_seconds": "15",
"thank_you_text": "Thank you",
"thank_you_url": "https://example.com/thankyou",
"preview_url": "https://cards.twitter.com/cards/abc1/xyz1",
"id": "xyz1",
"account_id": "abc1",
"created_at": "2015-09-03T00:03:16Z",
"updated_at": "2015-09-03T00:03:16Z",
"video_poster_url": "https://pbs.twimg.com/peacock/437011344609386496/image.jpg",
"deleted": false,
"card_type": "VIDEO_CONVERSATION"
}
],
"next_cursor": null,
"data_type": "card",
"request": {
"params": {
"card_type": "VIDEO_CONVERSATION",
"account_id": "abc1"
}
}
}