App Event Tags

GET accounts/:account_id/app_event_tags

Retrieve details for some or all app event tags associated with the current account.

These are what define the conversion windows set up per each conversion type for Mobile App Conversion Tracking.

Resource URL

https://ads-api.twitter.com/2/accounts/:account_id/app_event_tags

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

app_event_tag_ids
optional

Scope the response to just the desired app event tags by specifying a comma-separated list of identifiers. Up to 200 IDs may be provided.

Type: string

Example: jhp

count
optional

Specifies the number of records to try and retrieve per distinct request.

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional

Specifies a cursor to get the next page of results. See Pagination for more information.

Type: string

Example: 8x7v00oow

sort_by
optional

Sorts by supported attribute in ascending or descending order. See Sorting for more information.

Type: string

Example: created_at-asc

with_deleted
optional

Include deleted results in your request.

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional

Include the total_count response attribute.

Note: This parameter will be ignored if cursor is specified.

Note: Requests which include total_count will have lower rate limits, currently set at 200 per 15 minutes.

Type: boolean

Default: false
Possible values: true, false

Example Request

GET https://ads-api.twitter.com/2/accounts/18ce54d4x5t/app_event_tags?app_event_tag_ids=jhp

Example Response

{
  "request": {
    "params": {
      "app_event_tag_ids": [
        "jhp"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "provider_app_event_name": null,
      "app_store_identifier": "co.vine.android",
      "post_view_attribution_window": 1,
      "deep_link_scheme": "vine://",
      "id": "jhp",
      "retargeting_enabled": true,
      "account_id": "18ce54d4x5t",
      "conversion_type": "INSTALL",
      "created_at": "2016-12-08T07:49:58Z",
      "post_engagement_attribution_window": 14,
      "provider_app_event_id": null,
      "updated_at": "2016-12-08T23:07:54Z",
      "os_type": "ANDROID",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/app_event_tags/:app_event_tag_id

Retrieve a specific app event tag associated with the current account.

These are what define the conversion windows set up per each conversion type for Mobile App Conversion Tracking.

Resource URL

https://ads-api.twitter.com/2/accounts/:account_id/app_event_tags/:app_event_tag_id

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

app_event_tag_id
required

A reference to the app event tag you are operating with in the request.

Type: string

Example: jhp

with_deleted
optional

Include deleted results in your request.

Type: boolean

Default: false
Possible values: true, false

Example Request

GET https://ads-api.twitter.com/2/accounts/18ce54d4x5t/app_event_tags/jhp

Example Response

{
  "request": {
    "params": {
      "app_event_tag_id": "jhp",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "provider_app_event_name": null,
    "app_store_identifier": "co.vine.android",
    "post_view_attribution_window": 1,
    "deep_link_scheme": "vine://",
    "id": "jhp",
    "retargeting_enabled": true,
    "account_id": "18ce54d4x5t",
    "conversion_type": "INSTALL",
    "created_at": "2016-12-08T07:49:58Z",
    "post_engagement_attribution_window": 14,
    "provider_app_event_id": null,
    "updated_at": "2016-12-08T23:07:54Z",
    "os_type": "ANDROID",
    "deleted": false
  }
}

POST accounts/:account_id/app_event_tags

Create a new app event tag associated with the current account.

Resource URL

https://ads-api.twitter.com/2/accounts/:account_id/app_event_tags

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

app_store_identifier
required

The app store identifier.

Type: string

Example: com.twitter.android

conversion_type
required

The type of conversion event.

Type: enum

Possible values: ACHIEVEMENT_UNLOCKED, ADDED_PAYMENT_INFO, ADD_TO_CART, ADD_TO_WISHLIST, CHECKOUT_INITIATED, CONTENT_VIEW, INSTALL, INVITE, LEVEL_ACHIEVED, LOGIN, PURCHASE, RATED, RESERVATION, RE_ENGAGE, SEARCH, SHARE, SIGN_UP, SPENT_CREDITS, TUTORIAL_COMPLETE, UPDATE

os_type
required

The OS type for the app.

Type: enum

Possible values: IOS, ANDROID

provider_app_event_id
required

The ID of the conversion tag on provider’s site.

Type: string

Example: provider_tag_j5394

provider_app_event_name
required

The name of the conversion tag on provider’s site.

Type: string

Example: provider_name_a4382

deep_link_scheme
optional

Specify the deep link URI for the app associated with this tag.

Type: string

Example: twitter://

post_engagement_attribution_window
optional

The post-engagement attribution window for these events.

Type: int

Default: 30
Possible values: 1, 7, 14, 30
post_view_attribution_window
optional

The post-view attribution window for these events.

Type: int

Default: 1
Possible values: 0, 1, 7, 14, 30
retargeting_enabled
optional

Specify if retargeting should be enabled for this app event tag.

Type: boolean

Default: true
Possible values: true, false

Example Request

POST https://ads-api.twitter.com/2/accounts/18ce54d4x5t/app_event_tags?app_store_identifier=com.twitter.android&os_type=ANDROID&conversion_type=PURCHASE&provider_app_event_id=abc123&provider_app_event_name=test-tag

Example Response

{
  "data": {
    "provider_app_event_name": "test-tag",
    "app_store_identifier": "com.twitter.android",
    "post_view_attribution_window": 1,
    "deep_link_scheme": "https://",
    "id": "3p3t",
    "retargeting_enabled": true,
    "account_id": "18ce54d4x5t",
    "conversion_type": "PURCHASE",
    "created_at": "2017-09-06T06:58:22Z",
    "post_engagement_attribution_window": 30,
    "provider_app_event_id": "abc123",
    "updated_at": "2017-09-06T06:58:22Z",
    "os_type": "ANDROID",
    "deleted": false
  },
  "request": {
    "params": {
      "provider_app_event_name": "test-tag",
      "app_store_identifier": "com.twitter.android",
      "account_id": "18ce54d4x5t",
      "conversion_type": "PURCHASE",
      "provider_app_event_id": "abc123",
      "os_type": "ANDROID"
    }
  }
}

DELETE accounts/:account_id/app_event_tags/:id

Delete the specified app event tag belonging to the current account.

Resource URL

https://ads-api.twitter.com/2/accounts/:account_id/app_event_tags/:id

Parameters

Name Description
account_id
required

The identifier for the leveraged account. Appears within the resource’s path and is generally a required parameter for all Advertiser API requests excluding GET accounts. The specified account must be associated with the authenticated user.

Type: string

Example: 18ce54d4x5t

id
required

A reference to the app event tag you are operating with in the request.

Type: string

Example: jhp

Example Request

DELETE https://ads-api.twitter.com/2/accounts/18ce54d4x5t/app_event_tags/jhp

Example Response

{
  "data": {
    "provider_app_event_name": null,
    "app_store_identifier": "co.vine.android",
    "post_view_attribution_window": 1,
    "deep_link_scheme": "vine://",
    "id": "jhp",
    "retargeting_enabled": true,
    "account_id": "18ce54d4x5t",
    "conversion_type": "INSTALL",
    "created_at": "2016-12-08T07:49:58Z",
    "post_engagement_attribution_window": 14,
    "provider_app_event_id": null,
    "updated_at": "2017-08-30T05:44:57Z",
    "os_type": "ANDROID",
    "deleted": true
  },
  "request": {
    "params": {
      "id": "jhp",
      "account_id": "5gvk9h"
    }
  }
}