Pope Tech (1.0)

Download OpenAPI specification:Download

Crawls

Start a Crawl

path Parameters
organizationSlug
required
string
websitePublicId
required
string
header Parameters
Authorization
required
string
Example: Bearer [YOUR-ACCESS-TOKEN]

Your access token

Responses

Response samples

Content type
application/json
{
  • "data":
    {
    }
}

List Crawls

List crawls

path Parameters
organizationSlug
required
string
query Parameters
limit
integer [ 5 .. 250 ]
Default: 5
page
integer >= 1
Default: 1
status
string
Default: "active"
Enum: "all" "active" "finished"
header Parameters
Authorization
required
string
Example: Bearer [YOUR-ACCESS-TOKEN]

Your access token

Responses

Response samples

Content type
application/json
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Crawl Details

path Parameters
organizationSlug
required
string
publicId
required
string
header Parameters
Authorization
required
string
Example: Bearer [YOUR-ACCESS-TOKEN]

Your access token

Responses

Response samples

Content type
application/json
{
  • "started_at": "string",
  • "updated_at": "string",
  • "pages_found": 0,
  • "pages_added": 0,
  • "pages_archived": 0,
  • "status": "Queued",
  • "type": "string",
  • "public_id": "string",
  • "max_pages": "string",
  • "max_depth": "string",
  • "error_message": null,
  • "include_subdomains": true,
  • "rate_limit": null,
  • "filters":
    [
    ],
  • "start_url": "string",
  • "sitemap_location": "string",
  • "use_robots": true,
  • "use_sitemap": true,
  • "archive_pages_not_found": true
}

Reports

List Reports

path Parameters
organizationSlug
required
string
query Parameters
group_filter
string
sort_by
string
sort_direction
string
start
string
end
string
page
string
limit
string
header Parameters
Authorization
required
string
Example: Bearer [YOUR-ACCESS-TOKEN]

Your access token

Responses

Response samples

Content type
application/json
{
  • "meta":
    {
    },
  • "data":
    [
    ]
}

Create a Report

path Parameters
organizationSlug
required
string
header Parameters
Authorization
required
string
Example: Bearer [YOUR-ACCESS-TOKEN]

Your access token

Request Body schema: application/json
region
string
Default: "none"
Enum: "none" "all" "template" "content"
website
string

The public ID of the website to run the report on. Either website or group is required.

group
string

The public ID of the group to run the report on. Either website or group is required.