Vai al contenuto principale

​
API Utilizzo | Twitter API

​
Panoramica

Enterprise È lo strumento più importante e il più efficace per monitorare e gestire l’utilizzo delle diverse API associate al tuo account. Avvertenza importante: I conteggi di utilizzo restituiti dalla Usage API potrebbero non corrispondere a quelli riportati in fattura a causa di periodi di prova e di altri adeguamenti di fatturazione. Tutti i valori si basano su attività deduplicate consumate nell’arco di una determinata giornata (UTC).

​
Funzionalità

  • Recupero programmatico dei dati di utilizzo disponibili nell’interfaccia di console.gnip.com
  • Dati di utilizzo a livello di stream - fornisce dati di utilizzo a livello di stream (ad es. dev e prod) oltre che a livello di prodotto
  • Dati granulari e descrittivi - le richieste di ricerca sono suddivise tra i prodotti Full-Archive e 30-Day Search
  • “Giorni” e “job” in Historical PowerTrack 

​
API supportate

Di seguito è riportato l’elenco delle API attualmente supportate dalla Usage API:
  • PowerTrack API Enterprise
  • 30-Day Search API Enterprise
  • Full-Archive Search API Enterprise
  • Historical PowerTrack Enterprise

​
Limitazioni

  • La Usage API consente di accedere ai dati di utilizzo a partire dal 1° maggio 2018. Dopo il 1° luglio 2019, la Usage API consente di accedere ai dati di utilizzo per gli ultimi 13 mesi di calendario
  • È possibile accedere ai dati di utilizzo in intervalli di tre mesi, definiti con fromDate e toDate
Di seguito un esempio di richiesta e risposta: 
curl -u<username>:<password> \
"https://gnip-api.x.com/metrics/usage/accounts/<account-name>.json?bucket=month"

{
  "account": {
    "name": "accountnamehere"
  },
  "publishers": [
    {
      "type": "twitter",
      "used": [
        {
          "timePeriod": "201805010000",
          "activities": 1235,
          "searchRequests30Day": 3,
          "searchRequestsFullArchive": 19,
          "historicalPowertrackDays": 0,
          "historicalPowertrackJobs": 0
        },
        {
          "timePeriod": "201806010000",
          "activities": 23467,
          "searchRequests30Day": 0,
          "searchRequestsFullArchive": 66,
          "historicalPowertrackDays": 0,
          "historicalPowertrackJobs": 0
        },
        {
          "timePeriod": "201807010000",
          "activities": 431,
          "searchRequests30Day": 11,
          "searchRequestsFullArchive": 4,
          "historicalPowertrackDays": 0,
          "historicalPowertrackJobs": 0
        }
      ],
      "projected": {
        "timePeriod": "201807010000",
        "activities": 803,
        "searchRequests30Day": 20,
        "searchRequestsFullArchive": 7,
        "historicalPowertrackDays": 0,
        "historicalPowertrackJobs": 0
      },
      "products": [
        {
          "type": "Historical PowerTrack Subscription",
          "used": [
            {
              "timePeriod": "201805010000",
              "activities": 0,
              "days": 0,
              "jobs": 0
            },
            {
              "timePeriod": "201806010000",
              "activities": 0,
              "days": 0,
              "jobs": 0
            },
            {
              "timePeriod": "201807010000",
              "activities": 0,
              "days": 0,
              "jobs": 0
            }
          ],
          "projected": {
            "timePeriod": "201807010000",
            "activities": 0,
            "days": 0,
            "jobs": 0
          }
        },
        {
          "type": "PowerTrack",
          "used": [
            {
              "timePeriod": "201805010000",
              "activities": 267
            },
            {
              "timePeriod": "201806010000",
              "activities": 3
            },
            {
              "timePeriod": "201807010000",
              "activities": 32
            }
          ],
          "projected": {
            "timePeriod": "201807010000",
            "activities": 59
          },
          "endpoints": [
            {
              "type": "PowerTrack 2.0",
              "label": "actformat",
              "used": [
                {
                  "timePeriod": "201805010000",
                  "activities": 0
                },
                {
                  "timePeriod": "201806010000",
                  "activities": 0
                },
                {
                  "timePeriod": "201807010000",
                  "activities": 0
                }
              ],
              "projected": {
                "timePeriod": "201807010000",
                "activities": 0
              }
            },
              {
              "type": "PowerTrack Replay 2.0",
              "label": "ogformat",
              "used": [
                {
                  "timePeriod": "201805010000",
                  "activities": 0
                },
                {
                  "timePeriod": "201806010000",
                  "activities": 0
                },
                {
                  "timePeriod": "201807010000",
                  "activities": 0
                }
              ],
              "projected": {
                "timePeriod": "201807010000",
                "activities": 0
              }
            }
          ]
        },
        {
          "type": "Search API (30-Day) 2.0",
          "used": [
            {
              "timePeriod": "201805010000",
              "activities": 10,
              "searchRequests30Day": 3
            },
            {
              "timePeriod": "201806010000",
              "activities": 0,
              "searchRequests30Day": 0
            },
            {
              "timePeriod": "201807010000",
              "activities": 23,
              "searchRequests30Day": 11
            }
          ],
          "projected": {
            "timePeriod": "201807010000",
            "activities": 42,
            "searchRequests30Day": 20
          },
          "endpoints": [
            {
              "type": "Search API (30-Day) 2.0",
              "label": "ogformat",
              "used": [
                {
                  "timePeriod": "201805010000",
                  "activities": 10,
                  "searchRequests30Day": 3
                },
                {
                  "timePeriod": "201806010000",
                  "activities": 0,
                  "searchRequests30Day": 0
                },
                {
                  "timePeriod": "201807010000",
                  "activities": 21,
                  "searchRequests30Day": 10
                }
              ],
              "projected": {
                "timePeriod": "201807010000",
                "activities": 39,
                "searchRequests30Day": 18
              }
            }
          ]
        },
        {
          "type": "Search API (Full-Archive)",
          "used": [
            {
              "timePeriod": "201805010000",
              "activities": 961,
              "searchRequestsFullArchive": 19
            },
            {
              "timePeriod": "201806010000",
              "activities": 23466,
              "searchRequestsFullArchive": 66
            },
            {
              "timePeriod": "201807010000",
              "activities": 379,
              "searchRequestsFullArchive": 4
            }
          ],
          "projected": {
            "timePeriod": "201807010000",
            "activities": 706,
            "searchRequestsFullArchive": 7
          },
          "endpoints": [
            {
              "type": "Search API (Full-Archive)",
              "label": "actformat",
              "used": [
                {
                  "timePeriod": "201805010000",
                  "activities": 1,
                  "searchRequestsFullArchive": 3
                },
                {
                  "timePeriod": "201806010000",
                  "activities": 0,
                  "searchRequestsFullArchive": 0
                },
                {
                  "timePeriod": "201807010000",
                  "activities": 2,
                  "searchRequestsFullArchive": 1
                }
              ],
              "projected": {
                "timePeriod": "201807010000",
                "activities": 3,
                "searchRequestsFullArchive": 1
              }
            },
            {
              "type": "Search API (Full-Archive)",
              "label": "ogformat",
              "used": [
                {
                  "timePeriod": "201805010000",
                  "activities": 961,
                  "searchRequestsFullArchive": 16
                },
                {
                  "timePeriod": "201806010000",
                  "activities": 23466,
                  "searchRequestsFullArchive": 66
                },
                {
                  "timePeriod": "201807010000",
                  "activities": 379,
                  "searchRequestsFullArchive": 3
                }
              ],
              "projected": {
                "timePeriod": "201807010000",
                "activities": 706,
                "searchRequestsFullArchive": 5
              }
            }
          ]
        }
      ]
    }
  ],
  "bucket": "month",
  "fromDate": "201805010000",
  "toDate": "201808010000"
}

​
Payload di esempio

Di seguito un esempio di payload: 
{
  "account": {
    "name": "gnip-username"
  },
  "bucket": "month",
  "publishers": [
    {
      "type": "automattic",
      "used": [
        {
          "activities": 0,
          "timePeriod": "201603010000"
        }
      ],
      "projected": {
        "activities": 0,
        "timePeriod": "201603010000"
      },
      "products": [
        {
          "type": "PowerTrack",
          "used": [
            {
              "timePeriod": "201603010000",
              "activities": 0
            }
          ],
          "projected": {
            "timePeriod": "201603010000",
            "activities": 0
          },
          "endpoints": [
            {
              "type": "PowerTrack",
              "label": "dev",
              "used": [
                {
                  "timePeriod": "201603010000",
                  "activities": 0
                }
              ],
              "projected": {
                "timePeriod": "201603010000",
                "activities": 0
              }
            }
          ]
        }
      ]
    },
    {
      "type": "twitter",
      "used": [
        {
          "activities": 84,
          "searchRequests30Day": 4,
          "searchRequestsFullArchive": 0,
          "historicalPowertrackDays": 0,
          "historicalPowertrackJobs": 0,
          "timePeriod": "201603010000"
        }
      ],
      "projected": {
        "activities": 0,
        "searchRequests30Day": 0,
        "searchRequestsFullArchive": 0,
        "historicalPowertrackDays": 0,
        "historicalPowertrackJobs": 0,
        "timePeriod": "201601010000"
      },
      "products": [
        {
          "type": "Historical PowerTrack 2.0",
          "used": [
            {
              "timePeriod": "201511010000",
              "activities": 11884,
              "days": 5,
              "jobs": 5
            },
            {
              "timePeriod": "201512010000",
              "activities": 0,
              "days": 0,
              "jobs": 0
            },
            {
              "timePeriod": "201601010000",
              "activities": 0,
              "days": 0,
              "jobs": 0
            }
          ]
        },
        {
          "type": "PowerTrack",
          "used": [
            {
              "timePeriod": "201511010000",
              "activities": 0
            },
            {
              "timePeriod": "201512010000",
              "activities": 27456
            },
            {
              "timePeriod": "201601010000",
              "activities": 0
            }
          ],
          "projected": {
            "timePeriod": "201601010000",
            "activities": 0
          },
          "endpoints": [
            {
              "type": "PowerTrack",
              "label": "devel",
              "used": [
                {
                  "timePeriod": "201511010000",
                  "activities": 0
                },
                {
                  "timePeriod": "201512010000",
                  "activities": 2930
                },
                {
                  "timePeriod": "201601010000",
                  "activities": 0
                }
              ],
              "projected": {
                "timePeriod": "201601010000",
                "activities": 0
              }
            },
            {
              "type": "PowerTrack 2.0",
              "label": "devel-v2",
              "used": [
                {
                  "timePeriod": "201511010000",
                  "activities": 0
                },
                {
                  "timePeriod": "201512010000",
                  "activities": 24542
                },
                {
                  "timePeriod": "201601010000",
                  "activities": 0
                }
              ],
              "projected": {
                "timePeriod": "201601010000",
                "activities": 0
              }
            },
            {
              "type": "PowerTrack 2.0",
              "label": "devel-v2-1",
              "used": [
                {
                  "timePeriod": "201511010000",
                  "activities": 0
                },
                {
                  "timePeriod": "201512010000",
                  "activities": 0
                },
                {
                  "timePeriod": "201601010000",
                  "activities": 0
                }
              ],
              "projected": {
                "timePeriod": "201601010000",
                "activities": 0
              }
            }
          ]
        },
        {
          "type": "Search API",
          "used": [
            {
              "timePeriod": "201511010000",
              "activities": 0,
              "searchRequests30Day": 0
            },
            {
              "timePeriod": "201512010000",
              "activities": 0,
              "searchRequests30Day": 0
            },
            {
              "timePeriod": "201601010000",
              "activities": 0,
              "searchRequests30Day": 0
            }
          ],
          "projected": {
            "timePeriod": "201601010000",
            "activities": 0,
            "searchRequests30Day": 0
          },
          "endpoints": [
            {
              "type": "Search API",
              "label": "devel",
              "used": [
                {
                  "timePeriod": "201511010000",
                  "activities": 0,
                  "searchRequests30Day": 0
                },
                {
                  "timePeriod": "201512010000",
                  "activities": 0,
                  "searchRequests30Day": 0
                },
                {
                  "timePeriod": "201601010000",
                  "activities": 0,
                  "searchRequests30Day": 0
                }
              ],
              "projected": {
                "timePeriod": "201601010000",
                "activities": 0,
                "searchRequests30Day": 0
              }
            }
          ]
        },
        {
          "type": "Search API (30-Day)",
          "used": [
            {
              "timePeriod": "201511010000",
              "activities": 0,
              "searchRequests30Day": 0
            },
            {
              "timePeriod": "201512010000",
              "activities": 0,
              "searchRequests30Day": 0
            },
            {
              "timePeriod": "201601010000",
              "activities": 0,
              "searchRequests30Day": 0
            }
          ],
          "projected": {
            "timePeriod": "201601010000",
            "activities": 0,
            "searchRequests30Day": 0
          },
          "endpoints": [
            {
              "type": "Search API (30-Day)",
              "label": "devel",
              "used": [
                {
                  "timePeriod": "201511010000",
                  "activities": 0,
                  "searchRequests30Day": 0
                },
                {
                  "timePeriod": "201512010000",
                  "activities": 0,
                  "searchRequests30Day": 0
                },
                {
                  "timePeriod": "201601010000",
                  "activities": 0,
                  "searchRequests30Day": 0
                }
              ],
              "projected": {
                "timePeriod": "201601010000",
                "activities": 0,
                "searchRequests30Day": 0
              }
            }
          ]
        },
        {
          "type": "Search API (Full-Archive)",
          "used": [
            {
              "timePeriod": "201511010000",
              "activities": 0,
              "searchRequestsFullArchive": 0
            },
            {
              "timePeriod": "201512010000",
              "activities": 0,
              "searchRequestsFullArchive": 0
            },
            {
              "timePeriod": "201601010000",
              "activities": 0,
              "searchRequestsFullArchive": 0
            }
          ],
          "projected": {
            "timePeriod": "201601010000",
            "activities": 0,
            "searchRequestsFullArchive": 0
          },
          "endpoints": [
            {
              "type": "Search API (Full-Archive)",
              "label": "devel",
              "used": [
                {
                  "timePeriod": "201511010000",
                  "activities": 0,
                  "searchRequestsFullArchive": 0
                },
                {
                  "timePeriod": "201512010000",
                  "activities": 0,
                  "searchRequestsFullArchive": 0
                },
                {
                  "timePeriod": "201601010000",
                  "activities": 0,
                  "searchRequestsFullArchive": 0
                }
              ],
              "projected": {
                "timePeriod": "201601010000",
                "activities": 0,
                "searchRequestsFullArchive": 0
              }
            }
          ]
        }
      ]
    }
  ]
}

​
Riferimento all’API

​
get-usage

​
Metodi

MetodoDescrizione
GET /metrics/usage/accounts/.jsonRecupera i dati di utilizzo
Dove:
  • :account_name è il nome (con distinzione tra maiuscole e minuscole) associato al suo account, come visualizzato su console.gnip.com

​
Autenticazione e rate limit

Autenticazione
Tutte le richieste alla Usage API richiedono l’autenticazione HTTP Basic, utilizzando una delle credenziali e‑mail/password abilitate sul tuo account per accedere a console.gnip.com o connetterti a qualsiasi stream Gnip.
Limite di velocità
L’API Usage applica un limite di velocità di due richieste al minuto.

​
Best practice e limitazioni

Disponibilità dei dati
I dati di utilizzo si basano su attività deduplicate raccolte fino all’ultimo periodo completo (UTC) in cui i dati sono stati elaborati. In generale, i dati vengono elaborati e aggiornati fino al minuto, salvo nei casi in cui Gnip stia effettuando il deployment dei sistemi.
  • La Usage API consente di accedere ai dati di utilizzo a partire dal 1º maggio 2018. Dopo il 1º luglio 2019, la Usage API consente di accedere ai dati di utilizzo relativi agli ultimi 13 mesi di calendario.
  • Puoi accedere ai dati di utilizzo in intervalli di tre mesi definiti da un fromDate e un toDate

​
Richiesta e ricezione dei dati

L’API Usage funziona effettuando una richiesta HTTP GET con credenziali HTTP BASIC-AUTH all’endpoint dell’API del tuo account.
Richiesta GET:
Esegui una richiesta GET al seguente endpoint con le tue credenziali utente e il nome dell’account: https://gnip-api.x.com/metrics/usage/accounts/:account&#95;name.json Parametri aggiuntivi
bucketFacoltativo. L’unità di tempo per cui verranno forniti i dati di utilizzo. I dati di utilizzo possono essere restituiti con granularità giornaliera o mensile.

Le richieste senza un bucket specificato restituiranno dati con granularità mensile.

Opzioni: “month” oppure “day”
fromDate (YYYYMMDDHHMM)Facoltativo. I dati di utilizzo sono disponibili solo a partire dal 1° maggio 2018. Il timestamp UTC più remoto da cui verranno forniti i dati di utilizzo. Il timestamp ha granularità giornaliera ed è inclusivo (cioè 201805010000 include il giorno 0501). Le richieste che contengono valori diversi da “0000” per ore e minuti verranno impostate per impostazione predefinita su “0000”.

Le richieste senza fromDate o toDate restituiranno dati di utilizzo per mese relativi al mese corrente e includeranno un riferimento storico ai due mesi precedenti.

Nota: a partire dal 1° giugno 2019 è possibile accedere ai dati di utilizzo degli ultimi 13 mesi di calendario. Ad esempio, se fosse il 10 ottobre, si può accedere ai dati fino al 1° settembre dell’anno precedente.
Esempio: 201810010000 restituirà i dati a partire dal 1° ottobre 2018, incluso il 1° ottobre.
toDate (YYYYMMDDHHMM)Facoltativo. L’ultimo timestamp UTC fino al quale verranno forniti i dati di utilizzo. Il timestamp ha granularità giornaliera e non è inclusivo (cioè 201703020000 non include i dati per il giorno 0302). Quando un toDate è specificato per il giorno corrente o per un giorno futuro, i dati di utilizzo verranno restituiti fino all’ultimo giorno completo (UTC). Le richieste che contengono valori diversi da “0000” per ore e minuti verranno impostate per impostazione predefinita su “0000”.

Una richiesta senza toDate utilizzerà come valore predefinito il bucket successivo (domani per bucket=day e il mese successivo per bucket=month). Una richiesta senza fromDate e toDate utilizzerà come valore predefinito bucket=month e mostrerà i dati per il mese corrente più i due mesi immediatamente precedenti.

Esempio: 201703050000 restituirà i dati fino al 5 marzo 2017, senza includere alcun dato del 5 marzo.
Esempio di richiesta GET Questa richiesta restituirà i dati con granularità mensile dal 1° marzo 2017 al 5 marzo 2017, senza includere alcun dato del 5 marzo 2017. curl -u “https://gnip-api.x.com/metrics/usage/accounts/:account&#95;name.json?bucket=month&amp;fromdate=201403010000&amp;toDate=201403150000”

​
Formato dei dati

Le seguenti tabelle descrivono le strutture dati al livello radice per i dati di utilizzo restituiti dalla Usage API. Per i fields con più livelli di sotto-campi, fai clic sui link forniti per visualizzare i dettagli dei sotto-campi. Se desideri vedere un esempio di payload completo della Usage API, visita questa pagina.
accountUn oggetto che rappresenta l’account per cui sono stati richiesti i dati di utilizzo.
bucketL’unità di tempo per cui vengono forniti i dati di utilizzo. Può essere “day” o “month”.
fromDateIl timestamp UTC meno recente per cui vuoi estrarre i dati di utilizzo (inclusivo).
toDateIl timestamp UTC più recente per cui vuoi estrarre i dati di utilizzo (esclusivo).
publishersInclude tre oggetti principali: Used, projected e products.
⌘I