X Ads
App · 16 actions
Read X advertising accounts, campaigns, ad groups, creatives, audiences and performance metrics.
Actions
| Action | What it does |
|---|---|
| Get account | Get account in X Ads. |
| Get account permissions | Get account permissions in X Ads. |
| Get analytics | Read synchronous advertising metrics for up to 20 entity IDs and at most seven days. |
| Get campaign | Get campaign in X Ads. |
| Get custom audience | Get custom audience in X Ads. |
| Get funding instrument | Get funding instrument in X Ads. |
| Get line item | Get line item in X Ads. |
| Get media creative | Get media creative in X Ads. |
| Get promoted post | Get promoted post in X Ads. |
| List accounts | List accounts in X Ads. |
| List campaigns | List campaigns in X Ads. |
| List custom audiences | List custom audiences in X Ads. |
| List funding instruments | List funding instruments in X Ads. |
| List line items | List line items in X Ads. |
| List media creatives | List media creatives in X Ads. |
| List promoted tweets | List promoted tweets in X Ads. |
Get account
Get account in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get account permissions
Get account permissions in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
Outputs
Response.
dataobject- Account access response.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": {
"permissions": [],
"user_id": "Example"
}
},
"has_more": false,
"next_cursor": null
}Get analytics
Read synchronous advertising metrics for up to 20 entity IDs and at most seven days. Longer reports require the asynchronous Ads API.
Inputs
- Account
account_idtextRequired - Account id.
- Entity
entitytextRequired - Entity.One of:
ACCOUNT,CAMPAIGN,LINE_ITEM,PROMOTED_TWEET,MEDIA_CREATIVE,FUNDING_INSTRUMENT. - Entity IDs
entity_idslistRequired - Entity ids.
- Granularity
granularitytextRequired - Granularity.One of:
HOUR,DAY,TOTAL. - Placement
placementtextRequired - Placement.One of:
ALL_ON_TWITTER,PUBLISHER_NETWORK. - Metric groups
metric_groupslistRequired - Metric groups.One or more of:
ENGAGEMENT,BILLING,VIDEO,WEB_CONVERSION,MOBILE_CONVERSION,LIFE_TIME_VALUE,MEDIA. - Start time
start_timedate and timeRequired - Start time.
- End time
end_timedate and timeRequired - End time.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}Get campaign
Get campaign in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Record
record_idtextRequired - Record id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get custom audience
Get custom audience in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Record
record_idtextRequired - Record id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get funding instrument
Get funding instrument in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Record
record_idtextRequired - Record id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get line item
Get line item in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Record
record_idtextRequired - Record id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get media creative
Get media creative in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Record
record_idtextRequired - Record id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get promoted post
Get promoted post in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Record
record_idtextRequired - Record id.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List accounts
List accounts in X Ads.
Inputs
- Cursor
cursortext - Cursor.
- Count
countnumber - Count.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List campaigns
List campaigns in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Cursor
cursortext - Cursor.
- Count
countnumber - Count.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List custom audiences
List custom audiences in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Cursor
cursortext - Cursor.
- Count
countnumber - Count.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List funding instruments
List funding instruments in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Cursor
cursortext - Cursor.
- Count
countnumber - Count.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List line items
List line items in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Cursor
cursortext - Cursor.
- Count
countnumber - Count.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List media creatives
List media creatives in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Cursor
cursortext - Cursor.
- Count
countnumber - Count.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List promoted tweets
List promoted tweets in X Ads.
Inputs
- Account
account_idtextRequired - Account id.
- Cursor
cursortext - Cursor.
- Count
countnumber - Count.At least 1.
Outputs
Response.
dataobject- The official API response, including records and response metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token or offset to pass to the next request.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}