Requiere autorización
Consulta tus datos de tráfico de búsqueda con los filtros y parámetros que tú definas. El método muestra cero o más filas agrupadas por las claves de fila (dimensiones) que definas. Debe definir un período de uno o más días.
Si la fecha es una de las dimensiones, los días sin datos se omitirán de la lista de resultados. A fin de saber qué días tienen datos, emite una consulta sin filtros agrupados por fecha para el período de interés.
Los resultados se ordenan por recuento de clics de forma descendente. Si dos filas tienen el mismo recuento de clics, se ordenan de manera arbitraria.
Consulta el ejemplo de Python para llamar a este método.
La API está limitada por limitaciones internas de Search Console y no garantiza que se muestren todas las filas de datos, sino las principales.
Consulta los límites de la cantidad de datos disponibles.
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query?key={MY_API_KEY}
{
"startDate": "2015-04-01",
"endDate": "2015-05-01",
"dimensions": ["country","device"]
}Solicitud
Solicitud HTTP
POST https://www.googleapis.com/webmasters/v3/sites/siteUrl/searchAnalytics/query
Parámetros
| Nombre del parámetro | Valor | Descripción |
|---|---|---|
| Parámetros de ruta de acceso | ||
siteUrl |
string |
Es la URL de la propiedad, como se define en Search Console. Ejemplos:
http://www.example.com/ (para una propiedad de prefijo de URL) o sc-domain:example.com (para una Propiedad de dominio)
|
Autorización
Esta solicitud requiere autorización con al menos uno de los siguientes alcances (obtén más información acerca de la autenticación y autorización).
| Permiso |
|---|
https://www.googleapis.com/auth/webmasters.readonly |
https://www.googleapis.com/auth/webmasters |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporciona datos con la siguiente estructura:
{
"startDate": string,
"endDate": string,
"dimensions": [
string
],
"type": string,
"dimensionFilterGroups": [
{
"groupType": string,
"filters": [
{
"dimension": string,
"operator": string,
"expression": string
}
]
}
],
"aggregationType": string,
"rowLimit": integer,
"startRow": integer
}
| Nombre de la propiedad | Valor | Descripción | Notas |
|---|---|---|---|
startDate |
string |
[Obligatorio] Es la fecha de inicio del período solicitado, en formato AAAA-MM-DD, en la hora PT (UTC - 7:00/8:00). Debe ser anterior o igual a la fecha de finalización. Este valor se incluye en el rango. | |
endDate |
string |
[Obligatorio] Es la fecha de finalización del período solicitado, en formato AAAA-MM-DD, en la hora PT (UTC-7:00/8:00). Debe ser posterior o igual a la fecha de inicio. Este valor se incluye en el rango. | |
dimensions[] |
list |
[Opcional] Cero o más dimensiones para agrupar los resultados.Los resultados se agrupan en el orden en que proporcionas estas dimensiones.Puedes usar cualquier nombre de dimensión en dimensionFilterGroups[].filters[].dimension, así como "date".Los valores de las dimensiones de agrupación se combinan a fin de crear una clave única para cada fila de resultados. Si no se especifican dimensiones, todos los valores se combinarán en una sola fila. No hay límite para la cantidad de dimensiones que puedes agrupar, pero no puedes agrupar por la misma dimensión dos veces. Ejemplo: [país, dispositivo] | |
searchType |
string |
Obsoleto; usa type en su lugar
|
|
type |
string |
[Opcional] Filtra los resultados al siguiente tipo:
|
|
dimensionFilterGroups[] |
list |
[Opcional] Cero o más grupos de filtros que se aplicarán a los valores de la agrupación de dimensiones. Todos los grupos de filtros deben coincidir para que se muestre una fila en la respuesta. En un solo grupo de filtros, puedes especificar si todos los filtros deben coincidir o si al menos uno debe coincidir. | |
dimensionFilterGroups[].groupType |
string |
Indica si todos los filtros de este grupo deben mostrar valores verdaderos ("y"), o si uno o más deben mostrar valores verdaderos (aún no se admite).
Los valores aceptables son los siguientes:
|
|
dimensionFilterGroups[].filters[] |
list |
[Opcional] Cero o más filtros para probar en la fila. Cada filtro consta de un nombre de dimensión, un operador y un valor. La longitud máxima es de 4,096 caracteres. Ejemplos:
country equals FRA query contains mobile use device notContains tablet |
|
dimensionFilterGroups[].filters[].dimension |
string |
La dimensión a la que se aplica este filtro. Puedes filtrar por cualquier dimensión que se indique aquí, incluso si no te agrupas en función de esa dimensión.
Los valores aceptables son los siguientes:
|
|
dimensionFilterGroups[].filters[].operator |
string |
[Opcional] Indica cómo el valor especificado debe coincidir (o no) con el valor de la dimensión de la fila.
Los valores aceptables son los siguientes:
|
|
dimensionFilterGroups[].filters[].expression |
string |
El valor del filtro que debe coincidir o excluir, según el operador. | |
aggregationType |
string |
[Opcional] Cómo se agregan los datos. Si se agregan por propiedad, se agregan todos los datos de la misma propiedad. Si se agregan por página, se agrupan todos los datos por URI canónico. Si filtras o agrupas por página, elige la opción automática. De lo contrario, puedes agregar por propiedad o por página, según cómo quieras que se calculen tus datos. Consulta la documentación de ayuda para descubrir cómo se calculan los datos de manera diferente por sitio en comparación con página. Nota: Si agrupas o filtras por página, no puedes agregar por propiedad. Si especificas cualquier valor que no sea automático, el tipo de agregación en el resultado coincidirá con el tipo solicitado; si solicitas un tipo no válido, obtendrás un error. La API nunca cambiará tu tipo de agregación si el tipo solicitado no es válido. Los valores aceptables son los siguientes:
|
|
rowLimit |
integer |
[Opcional; el rango válido es de 1 a 25,000; el valor predeterminado es de 1,000] La cantidad máxima de filas que se mostrarán. Para desplazarte por los resultados, usa el desplazamiento startRow. |
|
startRow |
integer |
[Opcional; el valor predeterminado es 0] Índice basado en cero de la primera fila de la respuesta. Debe ser un número no negativo. Si startRow supera la cantidad de resultados para la consulta, la respuesta será exitosa y no tendrá filas. |
|
dataState |
string |
[Opcional] Si se muestra la opción “todos” (no distingue mayúsculas de minúsculas), los datos incluirán datos recientes. Si es "final" (no distingue mayúsculas de minúsculas) o si se omite este parámetro, los datos mostrados incluirán solo los datos finalizados. |
Respuesta
Los resultados se agrupan según las dimensiones especificadas en la solicitud. Todos los valores con el mismo conjunto de valores de dimensión se agruparán en una sola fila. Por ejemplo, si agrupas por dimensión de país, todos los resultados de "usa" se agruparán, todos los resultados de "mdv" se agruparán, y así sucesivamente. Si agrupaste los resultados por país y dispositivo, se agruparán todos los resultados de "usa, tableta", los resultados de "usa, móvil" y así sucesivamente. Consulta la documentación de informes de estadísticas de la Búsqueda para conocer los detalles sobre cómo se calculan los clics, las impresiones, etc., y qué significan.
Los resultados se ordenan por recuento de clics, en orden descendente, a menos que los agrupes por fecha, en cuyo caso los resultados se ordenan por fecha, en orden ascendente (más antiguos primero, más recientes al final). Si hay un empate entre dos filas, el orden es arbitrario.
Consulta la propiedad rowLimit en la solicitud para conocer la cantidad máxima de valores que se pueden mostrar.
{
"rows": [
{
"keys": [
string
],
"clicks": double,
"impressions": double,
"ctr": double,
"position": double
}
],
"responseAggregationType": string
}
| Nombre de la propiedad | Valor | Descripción | Notas |
|---|---|---|---|
rows[] |
list |
Una lista de filas agrupadas por valores clave en el orden determinado en la consulta. | |
rows[].keys[] |
list |
Una lista de los valores de dimensión para esa fila, agrupados según las dimensiones de la solicitud, en el orden especificado en la solicitud. | |
rows[].clicks |
double |
Recuento de clics de la fila | |
rows[].impressions |
double |
Recuento de impresiones para la fila. | |
rows[].ctr |
double |
Porcentaje de clics (CTR) de la fila. Los valores van del 0 al 1.0, ambos inclusive. | |
rows[].position |
double |
Posición promedio en los resultados de la búsqueda | |
responseAggregationType |
string |
Cómo se agregaron los resultados.Consulte la documentación de ayuda para obtener información sobre cómo se calculan los datos de manera diferente según el sitio y la página.
Los valores aceptables son los siguientes:
|
Pruébala
Utiliza el siguiente Explorador de APIs para llamar a este método con datos en tiempo real y ver la respuesta.