https://api.nexscope.ai/seo/aiTopCitedPagesEjecutar esta API
Envía una solicitud JSON para ejecutar esta API y recibir los datos de respuesta documentados.
Endpoint
| Método | POST |
| Ruta | https://api.nexscope.ai/seo/aiTopCitedPages |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
language | string | opcional | Valor de Language usado por esta operación de API. Constante: en Predeterminado: en |
limit | integer | opcional | Valor de Limit usado por esta operación de API. Predeterminado: 10 Mínimo: 1 Máximo: 20 |
market | string | opcional | Valor de Market usado por esta operación de API. Constante: US Predeterminado: US |
platform | string | opcional | Valor de Platform usado por esta operación de API. Permitidos: google, chat_gpt Predeterminado: google |
target | array | obligatorio | Valor de Target usado por esta operación de API. Cantidad mínima de elementos: 1 Cantidad máxima de elementos: 10 |
target[] | any | obligatorio | Elemento de target. |
Opción 1 de una alternativa — requiere kind, domain
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
target[] | object | obligatorio | Elemento de target. |
target[].domain | string | obligatorio | Nombre de host ASCII normalizado, de como máximo 63 caracteres. Longitud mínima: 1 |
target[].includeSubdomains | boolean | opcional | Valor de Include subdomains usado por esta operación de API. Predeterminado: false |
target[].kind | string | obligatorio | Valor de Kind usado por esta operación de API. Constante: DOMAIN |
target[].searchFilter | string | opcional | Valor de Search filter usado por esta operación de API. Permitidos: include, exclude Predeterminado: include |
Opción 2 de una alternativa — requiere kind, keyword
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
target[] | object | obligatorio | Elemento de target. |
target[].keyword | string | obligatorio | Eliminar espacios en los extremos, aplicar NFC y convertir a minúsculas: de 1 a 80 puntos de código, como máximo 10 palabras; sin los caracteres ASCII de porcentaje ni de suma. Longitud mínima: 1 |
target[].kind | string | obligatorio | Valor de Kind usado por esta operación de API. Constante: KEYWORD |
target[].matchType | string | opcional | Valor de Match type usado por esta operación de API. Permitidos: word_match, partial_match Predeterminado: word_match |
target[].searchFilter | string | opcional | Valor de Search filter usado por esta operación de API. Permitidos: include, exclude Predeterminado: include |
Respuesta de ejemplo
Estructura de respuesta de ejemplo del contrato documentado de la API de SEO.
{
"code": 0,
"cost": "-1",
"data": {
"callId": "synthetic-call",
"completedAt": null,
"coverage": {
"missing": [
{
"field": "synthetic",
"reason": "UPSTREAM_FIELD_MISSING"
}
],
"status": "PARTIAL"
},
"requestedAt": "123",
"result": {
"context": {
"domainSearchScope": "synthetic",
"inputTargets": [],
"keywordSearchScope": "synthetic",
"linksScope": "synthetic",
"normalizedTargets": [],
"ordering": "synthetic",
"platform": "synthetic",
"unsupportedDimensions": [
"synthetic"
]
},
"items": [
{
"metrics": {
"brandCategories": [
{
"counts": {
"aiSearchVolume": 9007199254740992,
"mentions": 9007199254740992
},
"value": "synthetic"
}
],
"brands": [
{
"counts": {
"aiSearchVolume": 9007199254740992,
"mentions": 9007199254740992
},
"value": "synthetic"
}
],
"searchResultDomains": [
{
"counts": {
"aiSearchVolume": 9007199254740992,
"mentions": 9007199254740992
},
"domain": "synthetic"
}
],
"sourceDomains": [
{
"counts": {
"aiSearchVolume": 9007199254740992,
"mentions": 9007199254740992
},
"domain": "synthetic"
}
],
"total": {
"aiSearchVolume": 9007199254740992,
"mentions": 9007199254740992
}
},
"missing": [
{
"field": "synthetic",
"reason": "synthetic"
}
],
"url": "synthetic"
}
],
"language": "synthetic",
"market": "synthetic",
"missing": [
{
"field": "synthetic",
"reason": "synthetic"
}
],
"returnedCount": 1,
"sourceKind": "synthetic",
"sourceProduct": "synthetic",
"summary": {
"brandCategories": [
{
"counts": {
"aiSearchVolume": 9007199254740992,
"mentions": 9007199254740992
},
"value": "synthetic"
}
],
"brands": [
{
"counts": {
"aiSearchVolume": 9007199254740992,
"mentions": 9007199254740992
},
"value": "synthetic"
}
],
"searchResultDomains": [
{
"counts": {
"aiSearchVolume": 9007199254740992,
"mentions": 9007199254740992
},
"domain": "synthetic"
}
],
"sourceDomains": [
{
"counts": {
"aiSearchVolume": 9007199254740992,
"mentions": 9007199254740992
},
"domain": "synthetic"
}
],
"total": {
"aiSearchVolume": 9007199254740992,
"mentions": 9007199254740992
}
},
"totalCount": 9007199254740992,
"truncated": false
},
"schemaVersion": "synthetic",
"source": "synthetic",
"status": "PARTIAL",
"usage": {
"billingStatus": "UNAPPROVED",
"chargedCredits": "0"
}
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": "synthetic-trace",
"ts": "9007199254740993"
}Campos de respuesta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 indica un sobre de respuesta satisfactorio; comprueba data.status por separado. Permitidos: 0, 42008, 42009 |
cost | string | obligatorio | Milisegundos transcurridos de procesamiento; no es el precio. -1 en un contexto no web. |
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.callId | string | null | opcional | Valor de Call id usado por esta operación de API. |
data.completedAt | string | integer | null | opcional | Valor de Completed at usado por esta operación de API. |
data.coverage | object | opcional | Valor de Coverage usado por esta operación de API. |
data.coverage.missing | array | opcional | Valor de Missing usado por esta operación de API. |
data.coverage.missing[] | object | obligatorio | Elemento de data coverage missing. |
data.coverage.missing[].field | string | opcional | Valor de Field usado por esta operación de API. |
data.coverage.missing[].reason | string | opcional | Valor de Reason usado por esta operación de API. |
data.coverage.status | string | opcional | Valor de Status usado por esta operación de API. |
data.requestedAt | string | integer | null | opcional | Valor de Requested at usado por esta operación de API. |
data.result | object | null | obligatorio | Valor de Result usado por esta operación de API. |
data.result.context | object | obligatorio | Valor de Context usado por esta operación de API. |
data.result.context.domainSearchScope | string | obligatorio | Valor de Domain search scope usado por esta operación de API. Constante: sources |
data.result.context.inputTargets | array | obligatorio | Valor de Input targets usado por esta operación de API. Cantidad mínima de elementos: 1 Cantidad máxima de elementos: 10 |
data.result.context.inputTargets[] | any | obligatorio | Elemento de data result context inputTargets. |
data.result.context.keywordSearchScope | string | obligatorio | Valor de Keyword search scope usado por esta operación de API. Constante: answer |
data.result.context.linksScope | string | obligatorio | Valor de Links scope usado por esta operación de API. Constante: sources |
data.result.context.normalizedTargets | array | obligatorio | Valor de Normalized targets usado por esta operación de API. Cantidad mínima de elementos: 1 Cantidad máxima de elementos: 10 |
data.result.context.normalizedTargets[] | any | obligatorio | Elemento de data result context normalizedTargets. |
data.result.context.ordering | string | obligatorio | Valor de Ordering usado por esta operación de API. Constante: provider_default |
data.result.context.platform | string | obligatorio | Valor de Platform usado por esta operación de API. Permitidos: google, chat_gpt Predeterminado: google |
data.result.context.unsupportedDimensions | array | obligatorio | Valor de Unsupported dimensions usado por esta operación de API. Cantidad mínima de elementos: 0 Cantidad máxima de elementos: 3 |
data.result.context.unsupportedDimensions[] | string | obligatorio | Elemento de data result context unsupportedDimensions. Permitidos: searchResultDomains, brands, brandCategories |
data.result.items | array | obligatorio | Valor de Items usado por esta operación de API. Cantidad mínima de elementos: 0 Cantidad máxima de elementos: 20 |
data.result.items[] | object | obligatorio | Elemento de data result items. |
data.result.items[].metrics | object | obligatorio | Valor de Metrics usado por esta operación de API. |
data.result.items[].metrics.brandCategories | array | null | obligatorio | Valor de Brand categories usado por esta operación de API. Cantidad mínima de elementos: 0 Cantidad máxima de elementos: 10 |
data.result.items[].metrics.brandCategories[] | object | obligatorio | Elemento de data result items[] metrics brandCategories. |
data.result.items[].metrics.brandCategories[].counts | object | obligatorio | Valor de Counts usado por esta operación de API. |
data.result.items[].metrics.brandCategories[].counts.aiSearchVolume | integer | null | obligatorio | Valor de Ai search volume usado por esta operación de API. Mínimo: 0 |
data.result.items[].metrics.brandCategories[].counts.mentions | integer | null | obligatorio | Valor de Mentions usado por esta operación de API. Mínimo: 0 |
data.result.items[].metrics.brandCategories[].value | string | obligatorio | Valor de Value usado por esta operación de API. |
data.result.items[].metrics.brands | array | null | obligatorio | Valor de Brands usado por esta operación de API. Cantidad mínima de elementos: 0 Cantidad máxima de elementos: 10 |
data.result.items[].metrics.brands[] | object | obligatorio | Elemento de data result items[] metrics brands. |
data.result.items[].metrics.brands[].counts | object | obligatorio | Valor de Counts usado por esta operación de API. |
data.result.items[].metrics.brands[].counts.aiSearchVolume | integer | null | obligatorio | Valor de Ai search volume usado por esta operación de API. Mínimo: 0 |
data.result.items[].metrics.brands[].counts.mentions | integer | null | obligatorio | Valor de Mentions usado por esta operación de API. Mínimo: 0 |
data.result.items[].metrics.brands[].value | string | obligatorio | Valor de Value usado por esta operación de API. |
data.result.items[].metrics.searchResultDomains | array | null | obligatorio | Valor de Search result domains usado por esta operación de API. Cantidad mínima de elementos: 0 Cantidad máxima de elementos: 10 |
data.result.items[].metrics.searchResultDomains[] | object | obligatorio | Elemento de data result items[] metrics searchResultDomains. |
data.result.items[].metrics.searchResultDomains[].counts | object | obligatorio | Valor de Counts usado por esta operación de API. |
data.result.items[].metrics.searchResultDomains[].counts.aiSearchVolume | integer | null | obligatorio | Valor de Ai search volume usado por esta operación de API. Mínimo: 0 |
data.result.items[].metrics.searchResultDomains[].counts.mentions | integer | null | obligatorio | Valor de Mentions usado por esta operación de API. Mínimo: 0 |
data.result.items[].metrics.searchResultDomains[].domain | string | obligatorio | Valor de Domain usado por esta operación de API. |
data.result.items[].metrics.sourceDomains | array | null | obligatorio | Valor de Source domains usado por esta operación de API. Cantidad mínima de elementos: 0 Cantidad máxima de elementos: 10 |
data.result.items[].metrics.sourceDomains[] | object | obligatorio | Elemento de data result items[] metrics sourceDomains. |
data.result.items[].metrics.sourceDomains[].counts | object | obligatorio | Valor de Counts usado por esta operación de API. |
data.result.items[].metrics.sourceDomains[].counts.aiSearchVolume | integer | null | obligatorio | Valor de Ai search volume usado por esta operación de API. Mínimo: 0 |
data.result.items[].metrics.sourceDomains[].counts.mentions | integer | null | obligatorio | Valor de Mentions usado por esta operación de API. Mínimo: 0 |
data.result.items[].metrics.sourceDomains[].domain | string | obligatorio | Valor de Domain usado por esta operación de API. |
data.result.items[].metrics.total | object | obligatorio | Valor de Total usado por esta operación de API. |
data.result.items[].metrics.total.aiSearchVolume | integer | null | obligatorio | Valor de Ai search volume usado por esta operación de API. Mínimo: 0 |
data.result.items[].metrics.total.mentions | integer | null | obligatorio | Valor de Mentions usado por esta operación de API. Mínimo: 0 |
data.result.items[].missing | array | obligatorio | Valor de Missing usado por esta operación de API. Cantidad mínima de elementos: 0 |
data.result.items[].missing[] | object | obligatorio | Elemento de data result items[] missing. |
data.result.items[].missing[].field | string | obligatorio | Valor de Field usado por esta operación de API. |
data.result.items[].missing[].reason | string | obligatorio | Valor de Reason usado por esta operación de API. Permitidos: UPSTREAM_FIELD_MISSING, UPSTREAM_FIELD_INVALID, DUPLICATE_UPSTREAM_ITEM, UPSTREAM_ITEM_MISSING |
data.result.items[].url | string | obligatorio | Valor de Url usado por esta operación de API. |
data.result.language | string | obligatorio | Valor de Language usado por esta operación de API. Constante: en |
data.result.market | string | obligatorio | Valor de Market usado por esta operación de API. Constante: US |
data.result.missing | array | obligatorio | Valor de Missing usado por esta operación de API. Cantidad mínima de elementos: 0 |
data.result.missing[] | object | obligatorio | Elemento de data result missing. |
data.result.missing[].field | string | obligatorio | Valor de Field usado por esta operación de API. |
data.result.missing[].reason | string | obligatorio | Valor de Reason usado por esta operación de API. Permitidos: UPSTREAM_FIELD_MISSING, UPSTREAM_FIELD_INVALID, DUPLICATE_UPSTREAM_ITEM, UPSTREAM_ITEM_MISSING |
data.result.returnedCount | integer | obligatorio | Valor de Returned count usado por esta operación de API. Mínimo: 0 |
data.result.sourceKind | string | obligatorio | Valor de Source kind usado por esta operación de API. Constante: llm_mentions_database |
data.result.sourceProduct | string | obligatorio | Valor de Source product usado por esta operación de API. Constante: ai_optimization |
data.result.summary | object | obligatorio | Valor de Summary usado por esta operación de API. |
data.result.summary.brandCategories | array | null | obligatorio | Valor de Brand categories usado por esta operación de API. Cantidad mínima de elementos: 0 Cantidad máxima de elementos: 10 |
data.result.summary.brandCategories[] | object | obligatorio | Elemento de data result summary brandCategories. |
data.result.summary.brandCategories[].counts | object | obligatorio | Valor de Counts usado por esta operación de API. |
data.result.summary.brandCategories[].counts.aiSearchVolume | integer | null | obligatorio | Valor de Ai search volume usado por esta operación de API. Mínimo: 0 |
data.result.summary.brandCategories[].counts.mentions | integer | null | obligatorio | Valor de Mentions usado por esta operación de API. Mínimo: 0 |
data.result.summary.brandCategories[].value | string | obligatorio | Valor de Value usado por esta operación de API. |
data.result.summary.brands | array | null | obligatorio | Valor de Brands usado por esta operación de API. Cantidad mínima de elementos: 0 Cantidad máxima de elementos: 10 |
data.result.summary.brands[] | object | obligatorio | Elemento de data result summary brands. |
data.result.summary.brands[].counts | object | obligatorio | Valor de Counts usado por esta operación de API. |
data.result.summary.brands[].counts.aiSearchVolume | integer | null | obligatorio | Valor de Ai search volume usado por esta operación de API. Mínimo: 0 |
data.result.summary.brands[].counts.mentions | integer | null | obligatorio | Valor de Mentions usado por esta operación de API. Mínimo: 0 |
data.result.summary.brands[].value | string | obligatorio | Valor de Value usado por esta operación de API. |
data.result.summary.searchResultDomains | array | null | obligatorio | Valor de Search result domains usado por esta operación de API. Cantidad mínima de elementos: 0 Cantidad máxima de elementos: 10 |
data.result.summary.searchResultDomains[] | object | obligatorio | Elemento de data result summary searchResultDomains. |
data.result.summary.searchResultDomains[].counts | object | obligatorio | Valor de Counts usado por esta operación de API. |
data.result.summary.searchResultDomains[].counts.aiSearchVolume | integer | null | obligatorio | Valor de Ai search volume usado por esta operación de API. Mínimo: 0 |
data.result.summary.searchResultDomains[].counts.mentions | integer | null | obligatorio | Valor de Mentions usado por esta operación de API. Mínimo: 0 |
data.result.summary.searchResultDomains[].domain | string | obligatorio | Valor de Domain usado por esta operación de API. |
data.result.summary.sourceDomains | array | null | obligatorio | Valor de Source domains usado por esta operación de API. Cantidad mínima de elementos: 0 Cantidad máxima de elementos: 10 |
data.result.summary.sourceDomains[] | object | obligatorio | Elemento de data result summary sourceDomains. |
data.result.summary.sourceDomains[].counts | object | obligatorio | Valor de Counts usado por esta operación de API. |
data.result.summary.sourceDomains[].counts.aiSearchVolume | integer | null | obligatorio | Valor de Ai search volume usado por esta operación de API. Mínimo: 0 |
data.result.summary.sourceDomains[].counts.mentions | integer | null | obligatorio | Valor de Mentions usado por esta operación de API. Mínimo: 0 |
data.result.summary.sourceDomains[].domain | string | obligatorio | Valor de Domain usado por esta operación de API. |
data.result.summary.total | object | obligatorio | Valor de Total usado por esta operación de API. |
data.result.summary.total.aiSearchVolume | integer | null | obligatorio | Valor de Ai search volume usado por esta operación de API. Mínimo: 0 |
data.result.summary.total.mentions | integer | null | obligatorio | Valor de Mentions usado por esta operación de API. Mínimo: 0 |
data.result.totalCount | integer | null | obligatorio | Valor de Total count usado por esta operación de API. Mínimo: 0 |
data.result.truncated | boolean | obligatorio | Valor de Truncated usado por esta operación de API. |
data.schemaVersion | string | null | opcional | Valor de Schema version usado por esta operación de API. |
data.source | string | null | opcional | Valor de Source usado por esta operación de API. |
data.status | string | opcional | Valor de Status usado por esta operación de API. Permitidos: SUCCESS, PARTIAL, EMPTY, PROCESSING, UNKNOWN, FAILED |
data.usage | object | null | opcional | Valor de Usage usado por esta operación de API. |
data.usage.billingStatus | string | null | opcional | Valor de Billing status usado por esta operación de API. |
data.usage.chargedCredits | string | integer | null | opcional | Valor de Charged credits usado por esta operación de API. |
msg | string | null | obligatorio | Para los casos satisfactorios y los fallos se prefiere el valor disponible de msg/errmsg/message del proveedor; el chino se traduce al inglés. Si falta el mensaje de éxito, su valor es null. Los errores propios de la plataforma y los estados de las tareas utilizan el inglés de la plataforma. El texto del mensaje nunca determina el éxito ni el reintento. |
time | string | obligatorio | yyyy-MM-dd HH:mm:ss |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Milisegundos desde el inicio de la época; serializador global de enteros long. |
Opción 1 de una alternativa — requiere kind, domain, searchFilter, includeSubdomains
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.context.inputTargets[] | object | obligatorio | Elemento de data result context inputTargets. |
data.result.context.inputTargets[].domain | string | obligatorio | Nombre de host ASCII normalizado, de como máximo 63 caracteres. Longitud mínima: 1 |
data.result.context.inputTargets[].includeSubdomains | boolean | obligatorio | Valor de Include subdomains usado por esta operación de API. Predeterminado: false |
data.result.context.inputTargets[].kind | string | obligatorio | Valor de Kind usado por esta operación de API. Constante: DOMAIN |
data.result.context.inputTargets[].searchFilter | string | obligatorio | Valor de Search filter usado por esta operación de API. Permitidos: include, exclude Predeterminado: include |
Opción 2 de una alternativa — requiere kind, keyword, searchFilter, matchType
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.context.inputTargets[] | object | obligatorio | Elemento de data result context inputTargets. |
data.result.context.inputTargets[].keyword | string | obligatorio | Eliminar espacios en los extremos, aplicar NFC y convertir a minúsculas: de 1 a 80 puntos de código, como máximo 10 palabras; sin los caracteres ASCII de porcentaje ni de suma. Longitud mínima: 1 |
data.result.context.inputTargets[].kind | string | obligatorio | Valor de Kind usado por esta operación de API. Constante: KEYWORD |
data.result.context.inputTargets[].matchType | string | obligatorio | Valor de Match type usado por esta operación de API. Permitidos: word_match, partial_match Predeterminado: word_match |
data.result.context.inputTargets[].searchFilter | string | obligatorio | Valor de Search filter usado por esta operación de API. Permitidos: include, exclude Predeterminado: include |
Opción 1 de una alternativa — requiere kind, domain, searchFilter, includeSubdomains
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.context.normalizedTargets[] | object | obligatorio | Elemento de data result context normalizedTargets. |
data.result.context.normalizedTargets[].domain | string | obligatorio | Nombre de host ASCII normalizado, de como máximo 63 caracteres. Longitud mínima: 1 |
data.result.context.normalizedTargets[].includeSubdomains | boolean | obligatorio | Valor de Include subdomains usado por esta operación de API. Predeterminado: false |
data.result.context.normalizedTargets[].kind | string | obligatorio | Valor de Kind usado por esta operación de API. Constante: DOMAIN |
data.result.context.normalizedTargets[].searchFilter | string | obligatorio | Valor de Search filter usado por esta operación de API. Permitidos: include, exclude Predeterminado: include |
Opción 2 de una alternativa — requiere kind, keyword, searchFilter, matchType
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.result.context.normalizedTargets[] | object | obligatorio | Elemento de data result context normalizedTargets. |
data.result.context.normalizedTargets[].keyword | string | obligatorio | Eliminar espacios en los extremos, aplicar NFC y convertir a minúsculas: de 1 a 80 puntos de código, como máximo 10 palabras; sin los caracteres ASCII de porcentaje ni de suma. Longitud mínima: 1 |
data.result.context.normalizedTargets[].kind | string | obligatorio | Valor de Kind usado por esta operación de API. Constante: KEYWORD |
data.result.context.normalizedTargets[].matchType | string | obligatorio | Valor de Match type usado por esta operación de API. Permitidos: word_match, partial_match Predeterminado: word_match |
data.result.context.normalizedTargets[].searchFilter | string | obligatorio | Valor de Search filter usado por esta operación de API. Permitidos: include, exclude Predeterminado: include |
Respuesta de procesamiento aceptado
code 0 confirma la aceptación. Usa data.callId para consultar la misma solicitud; el procesamiento no implica finalización.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 indica un sobre de respuesta satisfactorio; comprueba data.status por separado. Constante: 0 |
cost | string | obligatorio | Milisegundos transcurridos de procesamiento; no es el precio. -1 en un contexto no web. |
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.callId | string | null | obligatorio | Valor de Call id usado por esta operación de API. |
data.reason | string | obligatorio | Valor de Reason usado por esta operación de API. Constante: IN_PROGRESS |
data.retryable | boolean | opcional | Valor de Retryable usado por esta operación de API. |
data.status | string | obligatorio | Valor de Status usado por esta operación de API. Constante: PROCESSING |
data.taskId | string | null | opcional | Valor de Task id usado por esta operación de API. |
msg | string | null | obligatorio | Para los casos satisfactorios y los fallos se prefiere el valor disponible de msg/errmsg/message del proveedor; el chino se traduce al inglés. Si falta el mensaje de éxito, su valor es null. Los errores propios de la plataforma y los estados de las tareas utilizan el inglés de la plataforma. El texto del mensaje nunca determina el éxito ni el reintento. |
time | string | obligatorio | yyyy-MM-dd HH:mm:ss |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Milisegundos desde el inicio de la época; serializador global de enteros long. |
Respuesta de error
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 indica un sobre de respuesta satisfactorio; comprueba data.status por separado. |
cost | string | obligatorio | Milisegundos transcurridos de procesamiento; no es el precio. -1 en un contexto no web. |
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.callId | string | null | obligatorio | Valor de Call id usado por esta operación de API. |
data.reason | string | null | obligatorio | Valor de Reason usado por esta operación de API. |
data.retryable | boolean | opcional | Valor de Retryable usado por esta operación de API. |
data.status | string | null | obligatorio | Valor de Status usado por esta operación de API. |
data.taskId | string | null | opcional | Valor de Task id usado por esta operación de API. |
msg | string | null | obligatorio | Para los casos satisfactorios y los fallos se prefiere el valor disponible de msg/errmsg/message del proveedor; el chino se traduce al inglés. Si falta el mensaje de éxito, su valor es null. Los errores propios de la plataforma y los estados de las tareas utilizan el inglés de la plataforma. El texto del mensaje nunca determina el éxito ni el reintento. |
time | string | obligatorio | yyyy-MM-dd HH:mm:ss |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Milisegundos desde el inicio de la época; serializador global de enteros long. |
Obtener un resultado en procesamiento
Una respuesta conPROCESSING y un callIdsignifica que el resultado aún se está preparando. Usa la consulta de resultado siguiente con el identificador devuelto. Esta consulta lee el resultado guardado y no consume créditos.
curl -X GET https://api.nexscope.ai/seo/aiTopCitedPages/calls/{callId} \
-H "Authorization: Bearer nk-xxxxxxxxxxxxxxxxx"Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta HTTP predeterminada tanto para el éxito como para muchos errores de negocio. Solo el código JSON externo 0 indica éxito o aceptación asíncrona; consulta data para obtener el resultado. |
| 429 | Límite de admisión de ejecuciones; respeta Retry-After cuando esté presente. |
| 503 | La admisión de ejecuciones no está disponible temporalmente; respeta Retry-After cuando esté presente. |
| Opcional | X-Nexscope-Http-Status: semantic asigna estados HTTP a los errores de negocio gestionados por el controlador en las rutas de ejecución y tareas. Los fallos previos a la autenticación, como la ausencia de una clave API (code 11209), pueden seguir devolviendo HTTP 200 antes de esta asignación. Comprueba siempre el código JSON externo; las solicitudes malformadas y los fallos de infraestructura también pueden devolver respuestas HTTP distintas de 200. |
Fuente de datos, vigencia y limitaciones
La fuente, la vigencia, la cobertura, los límites de frecuencia y las notas de estimación no se especifican en esta definición de API salvo que aparezcan en la documentación de campos de solicitud o respuesta anterior. No supongas datos oficiales del mercado ni actualización en tiempo real cuando no estén documentados explícitamente.