API Terms Clarification

api

#1

Hi,

If anyone knows of where the below CSV fields from the API show up in the Twitter dashboard it would be great. In the process of mapping these onto metrics for a reporting dashboard and need to make sure they are pulling correctly. For context we have two conversions, Search and Booking.

conversion_tag_category (Mobile App/Website Conversions)
conversion_tag_external_id (Conversion Tag)
conversion_tag_name (Conversion Tag)
total_conversions (post_engagement + post_view)

Thanks


#2

Hi @JG123,

Depending on whether these are mobile app events or web conversion events. You would need to set metric_groups=MOBILE_CONVERSION or WEB_CONVERSION when pulling analytics. Below is an example from an account with the output of information you are looking to find. Please note in the future, provide account ID and or campaign IDs for us to use as examples or investigation if that were the case.

$ twurl -H ads-api.twitter.com "/3/stats/accounts/d4743?entity=CAMPAIGN&entity_ids=a7q3c&start_time=2018-01-15&end_time=2018-01-20&granularity=TOTAL&metric_groups=WEB_CONVERSION&placement=ALL_ON_TWITTER" | jq
{
  "data_type": "stats",
  "time_series_length": 1,
  "data": [
    {
      "id": "a7q3c",
      "id_data": [
        {
          "segment": null,
          "metrics": {
            "conversion_purchases": {
              "order_quantity_engagement": [
                16000000
              ],
              "sale_amount_engagement": [
                1688540000
              ],
              "sale_amount_view": [
                6105630000
              ],
              "post_view": [
                49
              ],
              "order_quantity": [
                79000000
              ],
              "assisted": null,
              "post_engagement": [
                16
              ],
              "sale_amount": [
                7794170000
              ],
              "metric": [
                65
              ],
              "order_quantity_view": [
                63000000
              ]
            },

Conversion tag category information covered above, you will have to pull both metric_groups should you need that information. The tag ID and the tag name will not be found in stats request, for web_conversions that data is grouped in conversion types (site visit, purchase, sign up, custom, & download).