Query Scraper Task

This is your first endpoint! Edit this page to start documenting your API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response

FieldTypeDescription
codeStringThe response code indicating status
messageStringMessage describing the response
resultObjectContains the result of the request
result.taskIdStringUnique identifier for the task
result.statusStringStatus of the task
result.errorMsgStringError message if any error occurred
result.productLinkStringURL link to the product
result.productNameStringName of the product
result.productDescriptionStringDescription of the product
result.productImagesArrayList of product images
result.productImages[].fileIdStringUnique identifier for the image
result.productImages[].fileNameStringName of the image file
result.productImages[].fileTypeStringType of the file (image)
result.productImages[].formatStringFormat of the image file
result.productImages[].fileUrlStringURL of the image file
result.productVideosArrayList of product videos
result.productVideos[].fileIdStringUnique identifier for the video
result.productVideos[].fileNameStringName of the video file
result.productVideos[].fileTypeStringType of the file (video)
result.productVideos[].formatStringFormat of the video file
result.productVideos[].fileUrlStringURL of the video file
Query Params
string
required
Defaults to fe9ca61f1a9e48c8b1e0c0ffd73efc7c
string
Headers
string
required
Defaults to <your-topview-uid>
string
required
Defaults to Bearer <your-api-key>
Response
200

Successful response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!