Skip to main content
GET
List opportunities

Authorizations

Authorization
string
header
required

ApiKey pq_<prefix>_<secret>. An API key gives read-only access.

Path Parameters

site_uuid
string<uuid>
required

Query Parameters

date_range
enum<string>
default:1a
  • 7g - 7g
  • 1a - 1a
  • 3a - 3a
  • 6a - 6a
  • 1y - 1y
  • custom - custom
Available options:
7g,
1a,
3a,
6a,
1y,
custom
Minimum string length: 1
direction
enum<string> | null
  • asc - asc
  • desc - desc
Available options:
asc,
desc,
null
Minimum string length: 1
include_dismissed
boolean
default:false
llm
enum<string>[]
  • chatgpt - chatgpt
  • gemini - gemini
  • claude - claude
  • perplexity - perplexity
  • googleai - googleai
  • grok - grok
  • deepseek - deepseek
Available options:
chatgpt,
gemini,
claude,
perplexity,
googleai,
grok,
deepseek
page
integer
default:1
Required range: x >= 1
page_size
integer
default:50
Required range: 1 <= x <= 100
q
string | null
since
string<date>

The first day of a custom range.

sort
enum<string>
default:score
  • score - score
  • effort - effort
  • volume - volume
  • type - type
  • subject - subject
Available options:
score,
effort,
volume,
type,
subject
Minimum string length: 1
subject_kind
enum<string> | null
  • site - site
  • page - page
  • prompt - prompt
  • domain - domain
Available options:
site,
page,
prompt,
domain,
null
Minimum string length: 1
subject_ref
string | null
tier
enum<string> | null
  • now - now
  • plan - plan
  • quick - quick
  • watch - watch
Available options:
now,
plan,
quick,
watch,
null
Minimum string length: 1
type
enum<string> | null
  • technical - technical
  • content - content
  • offpage - offpage
Available options:
technical,
content,
offpage,
null
Minimum string length: 1
until
string<date>

The last day of a custom range.

Response

200 - application/json
rows
object[]
required
total
integer
required
page
integer
required
page_size
integer
required
total_pages
integer
required
open_total
integer
required
open_by_type
object
required