https://api.nexscope.ai/seo/pageScreenshotEjecutar 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/pageScreenshot |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
device | string | opcional | Valor de Device usado por esta operación de API. Permitidos: DESKTOP, MOBILE Predeterminado: DESKTOP |
url | string | obligatorio | Valor de Url usado por esta operación de API. Longitud máxima: 2048 |
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": {
"coverage": {
"invalidItemCount": 1,
"limit": 1,
"maxCrawlPages": 9007199254740992,
"offset": 1,
"pagesCrawled": 9007199254740992,
"providerTotal": 9007199254740992,
"returnedCount": 1,
"sampled": false,
"stopReason": "synthetic",
"truncated": false
},
"items": [
{
"capturedAt": 9007199254740992,
"device": "synthetic",
"image": {
"artifactId": "synthetic",
"byteLength": 9007199254740992,
"downloadPath": "synthetic",
"expiresAt": 9007199254740992,
"height": 1,
"mediaType": "synthetic",
"sha256": "synthetic",
"width": 1
},
"url": "synthetic"
}
],
"missingFields": [
{
"field": "synthetic",
"reason": "synthetic"
}
],
"source": {
"candidateId": "synthetic",
"collectedAt": 9007199254740992,
"observationKind": "synthetic",
"product": "synthetic",
"provider": "synthetic",
"queriedAt": 9007199254740992,
"sourceCallId": "synthetic",
"sourcePlanVersion": "synthetic",
"sourceSchemaVersion": "synthetic"
},
"warnings": [
"synthetic"
]
},
"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.coverage | object | obligatorio | Valor de Coverage usado por esta operación de API. |
data.result.coverage.invalidItemCount | integer | obligatorio | Valor de Invalid item count usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.coverage.limit | integer | obligatorio | Valor de Limit usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.coverage.maxCrawlPages | integer | null | obligatorio | Valor de Max crawl pages usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.coverage.offset | integer | obligatorio | Valor de Offset usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.coverage.pagesCrawled | integer | null | obligatorio | Valor de Pages crawled usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.coverage.providerTotal | integer | null | obligatorio | Valor de Provider total usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.coverage.returnedCount | integer | obligatorio | Valor de Returned count usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.coverage.sampled | boolean | obligatorio | Valor de Sampled usado por esta operación de API. Constante: true |
data.result.coverage.stopReason | string | null | obligatorio | Valor de Stop reason usado por esta operación de API. |
data.result.coverage.truncated | boolean | obligatorio | Valor de Truncated usado por esta operación de API. |
data.result.items | array | obligatorio | Valor de Items usado por esta operación de API. Cantidad máxima de elementos: 1 |
data.result.items[] | object | obligatorio | Elemento de data result items. |
data.result.items[].capturedAt | integer | null | obligatorio | Valor de Captured at usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.items[].device | string | obligatorio | Valor de Device usado por esta operación de API. Permitidos: DESKTOP, MOBILE |
data.result.items[].image | object | null | obligatorio | Valor de Image usado por esta operación de API. |
data.result.items[].image.artifactId | string | obligatorio | Valor de Artifact id usado por esta operación de API. |
data.result.items[].image.byteLength | integer | obligatorio | Valor de Byte length usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.items[].image.downloadPath | string | obligatorio | Valor de Download path usado por esta operación de API. |
data.result.items[].image.expiresAt | integer | obligatorio | Valor de Expires at usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.items[].image.height | integer | obligatorio | Valor de Height usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.items[].image.mediaType | string | obligatorio | Valor de Media type usado por esta operación de API. Permitidos: image/png, image/jpeg |
data.result.items[].image.sha256 | string | obligatorio | Valor de Sha256 usado por esta operación de API. Patrón: ^[0-9a-f]{64}$ |
data.result.items[].image.width | integer | obligatorio | Valor de Width usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.items[].url | string | obligatorio | Valor de Url usado por esta operación de API. |
data.result.missingFields | array | obligatorio | Valor de Missing fields usado por esta operación de API. Cantidad máxima de elementos: 10000 |
data.result.missingFields[] | object | obligatorio | Elemento de data result missingFields. |
data.result.missingFields[].field | string | obligatorio | Valor de Field usado por esta operación de API. |
data.result.missingFields[].reason | string | obligatorio | Valor de Reason usado por esta operación de API. |
data.result.source | object | obligatorio | Valor de Source usado por esta operación de API. |
data.result.source.candidateId | string | obligatorio | Valor de Candidate id usado por esta operación de API. Constante: MD-PW-14 |
data.result.source.collectedAt | integer | null | obligatorio | Valor de Collected at usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.source.observationKind | string | obligatorio | Valor de Observation kind usado por esta operación de API. Constante: LIVE_PAGE_RENDER |
data.result.source.product | string | obligatorio | Valor de Product usado por esta operación de API. Constante: on_page |
data.result.source.provider | string | obligatorio | Valor de Provider usado por esta operación de API. Constante: DATAFORSEO |
data.result.source.queriedAt | integer | obligatorio | Valor de Queried at usado por esta operación de API. Mínimo: 0 Máximo: 9007199254740991 |
data.result.source.sourceCallId | string | null | obligatorio | Valor de Source call id usado por esta operación de API. |
data.result.source.sourcePlanVersion | string | null | obligatorio | Valor de Source plan version usado por esta operación de API. |
data.result.source.sourceSchemaVersion | string | null | obligatorio | Valor de Source schema version usado por esta operación de API. |
data.result.warnings | array | obligatorio | Valor de Warnings usado por esta operación de API. Cantidad máxima de elementos: 1000 |
data.result.warnings[] | string | obligatorio | Elemento de data result warnings. |
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. |
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/pageScreenshot/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.