Petstore logo
API docs by Redocly

WebTechSurvey API (1.0)

Download OpenAPI specification:Download

reports

List all reports

List all reports

header Parameters
wts-access-token
required
string <uuid>
Example: e7773981-dcd0-4e63-a987-78949aa9b909

Responses

Response samples

Content type
application/json
[
  • "2215b47b-fe82-d987-27f0-4464fadee162",
  • "3215b47b-fe82-d987-27f0-4464fadee162"
]

Create report

Creates a report based on a search criteria

Request Body schema: application/json
required
Array of objects non-empty
CallbackURL
string <uri>
object (CreateReportOptions)

Responses

Request samples

Content type
application/json
{
  • "Criterias": [
    ],
  • "CallbackURL": "http://example.com",
  • "Options": {
    }
}

Response samples

Content type
application/json
{
  • "id": "2215b47b-fe82-d987-27f0-4464fadee162"
}

Read report details

Provides access to report details

path Parameters
reportId
required
string <uuid>
Example: 2215b47b-fe82-d987-27f0-4464fadee162

The report identifier

header Parameters
wts-access-token
required
string <uuid>
Example: e7773981-dcd0-4e63-a987-78949aa9b909

Responses

Response samples

Content type
application/json
{}

Purchase report

Purchases the created report identified by the report ID.

path Parameters
reportId
required
string <uuid>
Example: 2215b47b-fe82-d987-27f0-4464fadee162

The report identifier

header Parameters
wts-access-token
required
string <uuid>
Example: e7773981-dcd0-4e63-a987-78949aa9b909
Request Body schema: application/json
creditsToPay
integer

Number of credits to spend for the report.

Responses

Request samples

Content type
application/json
{
  • "creditsToPay": 2500
}

Response samples

Delete report

This function deletes report identified by the Report ID.

path Parameters
reportId
required
string <uuid>
Example: 2215b47b-fe82-d987-27f0-4464fadee162

The report identifier

header Parameters
wts-access-token
required
string <uuid>
Example: e7773981-dcd0-4e63-a987-78949aa9b909

Responses

lookups

Lookup website(s) data (free)

Returns partial data about the specified domain from the database. You can use this data to preview domain info before spending credits with method /lookup

query Parameters
domain
string

Domain name which data to be retrieved

header Parameters
wts-access-token
required
string <uuid>
Example: e7773981-dcd0-4e63-a987-78949aa9b909

Responses

Lookup website(s) data

Returns data about the specified domain from the database

query Parameters
domain
string

Domain name which data to be retrieved

header Parameters
wts-access-token
required
string <uuid>
Example: e7773981-dcd0-4e63-a987-78949aa9b909

Responses

misc

Check available balances

Return available credits and reports

header Parameters
wts-access-token
required
string <uuid>
Example: e7773981-dcd0-4e63-a987-78949aa9b909

Responses

Response samples

Content type
application/json
{
  • "creditsAvailable": 12000,
  • "reportAvailable": 1
}