API de uso

La Usage API es una API REST gratuita que ofrece acceso programático y visibilidad del consumo de actividad en todos los productos de tu cuenta empresarial.

​

API de uso | Twitter API

​

Descripción general

Enterprise

Es la herramienta más importante y mejor para ayudar a supervisar y gestionar el uso en las diferentes API de tu cuenta.

Descargo de responsabilidad importante:

Los recuentos de uso devueltos por la Usage API pueden no coincidir con los de una factura debido a periodos de prueba y otros ajustes de facturación. Todos los números se basan en actividades sin duplicados consumidas en un día determinado (en UTC).

​

Features

• Recuperar de forma programática los datos de uso que están disponibles en la interfaz de usuario (UI) de console.gnip.com
• Datos de uso a nivel de stream: proporciona datos de uso a nivel de stream (por ejemplo, dev y prod), además de a nivel de producto
• Datos granulares y descriptivos: las solicitudes de búsqueda (“requests”) se desglosan por productos Full-Archive y 30-Day Search 
• “days” y “jobs” históricos de PowerTrack 

​

APIs compatibles

A continuación se muestra una lista de las APIs actualmente compatibles con la Usage API:

• PowerTrack API enterprise
• 30-Day Search API enterprise
• Full-Archive Search API enterprise
• Historical PowerTrack enterprise

​

Limitations

• Usage API te permite acceder a datos de uso desde el 1 de mayo de 2018. Después del 1 de julio de 2019, Usage API te permite acceder a datos de uso de los últimos 13 meses calendario.

• Puedes acceder a los datos de uso en intervalos de tres meses definidos con un fromDate y un toDate.

A continuación se muestra un ejemplo de solicitud y respuesta:

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": "Suscripción de Historical PowerTrack",
          "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"
}

​

Ejemplo de payload

A continuación, se muestra un ejemplo del 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
              }
            }
          ]
        }
      ]
    }
  ]
}

​

Referencia de la API

​

get-usage

​

Métodos

Método	Descripción
GET /metrics/usage/accounts/.json	Recuperar datos de uso

Donde:

• :account_name es el nombre (que distingue mayúsculas de minúsculas) asociado a tu cuenta, tal como aparece en console.gnip.com

​

Autenticación y límites de uso

Autenticación

Todas las solicitudes a la Usage API requieren autenticación básica HTTP, utilizando cualquiera de las credenciales de correo electrónico y contraseña habilitadas en tu cuenta, las mismas que usas para iniciar sesión en console.gnip.com o conectarte a cualquier flujo de Gnip.

Límite de frecuencia

La API Usage impone un límite de frecuencia de dos solicitudes por minuto.

​

Mejores prácticas y limitaciones

Disponibilidad de datos

Los datos de uso se basan en actividades deduplicadas consumidas hasta el último período completo (UTC) para el que se procesaron datos. En general, los datos se procesan y actualizan casi en tiempo real, salvo en los casos en que Gnip está implementando sistemas.

• La Usage API te permite acceder a datos de uso desde el 1 de mayo de 2018. A partir del 1 de julio de 2019, Usage API te permite acceder a datos de uso de los últimos 13 meses naturales. 

• Puedes acceder a datos de uso en intervalos de tres meses definidos con un fromDate y un toDate.

​

Solicitar y recibir datos

La API Usage funciona mediante el envío de una solicitud HTTP GET con credenciales HTTP BASIC-AUTH al endpoint de la API de tu cuenta.

Solicitud GET:

Realiza una solicitud GET al siguiente endpoint con tus credenciales de usuario y nombre de cuenta:

https://gnip-api.x.com/metrics/usage/accounts/:account_name.json

Parámetros adicionales

bucket	Opcional. La unidad de tiempo para la que se proporcionarán los datos de uso. Los datos de uso se pueden devolver con granularidad diaria o mensual. Las solicitudes realizadas sin un bucket especificado devolverán datos con granularidad mensual. Opciones: ‘month’ o ‘day’
fromDate (YYYYMMDDHHMM)	Opcional. Los datos de uso solo están disponibles a partir del 1 de mayo de 2018. Es la marca de tiempo UTC más antigua desde la cual se proporcionarán los datos de uso. La marca de tiempo tiene granularidad de día y es inclusiva (es decir, 201805010000 incluye el día 0501). Las solicitudes que contengan valores distintos de ‘0000’ para la granularidad de hora y minuto se restablecerán al valor predeterminado ‘0000’. Las solicitudes realizadas sin un fromDate o toDate devolverán datos de uso por mes para el mes actual e incluirán una referencia histórica de los dos meses anteriores. Ten en cuenta: A partir del 1 de junio de 2019, puedes acceder a los datos de uso de los últimos 13 meses naturales. Por ejemplo, si fuera el 10 de octubre, podrías acceder a los datos de uso hasta el 1 de septiembre del año anterior. Ejemplo: 201810010000 devolverá datos comenzando desde el 1 de octubre de 2018 en adelante, incluyendo el 1 de octubre.
toDate (YYYYMMDDHHMM)	Opcional. La marca de tiempo UTC más reciente hasta la cual se proporcionarán los datos de uso. La marca de tiempo tiene granularidad de día y no es inclusiva (es decir, 201703020000 no incluye datos para el día 0302). Cuando se especifica un toDate para el día actual o un día en el futuro, los datos de uso se devolverán hasta el último día completo (UTC). Las solicitudes que contengan valores distintos de ‘0000’ para la granularidad de hora y minuto se restablecerán al valor predeterminado ‘0000’. Una solicitud sin toDate tendrá como valor predeterminado el siguiente bucket (mañana para bucket=day y el próximo mes para bucket=month). Una solicitud realizada sin fromDate ni toDate tendrá como valor predeterminado bucket=month y mostrará datos para el mes actual más los dos meses inmediatamente anteriores. Ejemplo: 201703050000 devolverá datos hasta el 5 de marzo de 2017, sin incluir ningún dato del 5 de marzo.

Ejemplo de solicitud GET

Esta solicitud devolverá datos con granularidad mensual desde el 1 de marzo de 2017 hasta el 5 de marzo de 2017, sin incluir ningún dato del 5 de marzo de 2017.

curl -u “https://gnip-api.x.com/metrics/usage/accounts/:account_name.json?bucket=month&fromdate=201403010000&toDate=201403150000”

​

Formato de datos

Las siguientes tablas describen las estructuras de datos de nivel raíz para los datos de uso devueltos por la Usage API. Para los campos con varios niveles de subcampos, haz clic en los enlaces proporcionados para ver los detalles de los subcampos.

Si deseas ver un ejemplo de un payload completo de la Usage API, visita esta página.

account	Un objeto que representa la cuenta para la que se solicitaron los datos de uso.
bucket	La unidad de tiempo para la que se proporcionan los datos de uso. Puede ser ‘day’ o ‘month’.
fromDate	La primera marca de tiempo UTC para la que deseas obtener datos de uso (inclusive).
toDate	La última marca de tiempo UTC para la que deseas obtener datos de uso (exclusiva).
publishers	Incluye tres objetos principales: Used, projected y products.