Skip to main content
POST
Query Comparison Web Properties Configuration (Async)

Authorizations

Authorization
string
header
required

Conductor API token, sent as Bearer cond_<your-api-token>. Generate a token from Integrations > API > Create API Token.

Body

application/json

Submit a new query for comparison web properties. Returns an executionId to track the query.

account_id
integer
required

Required account ID to filter comparison web properties.

Required range: x >= 1
Example:

101

limit
integer
default:100

Maximum number of rows to return for the submitted query.

Required range: x >= 1
Example:

100

Response

Query completed successfully (returned when polling with queryExecutionId)

results
string[][]

List of query results. Each item is a positional tuple row. Available only when executionState is COMPLETED.

Positional tuple row for comparison web properties configuration results. Values are returned as strings in the following order:

  1. web_property_id, 2) web_property_name, 3) attribution_label, 4) root_domains, 5) compared_against.
Required array length: 5 elements
executionState
enum<string>

Current execution state of the query:

  • IN_PROGRESS: The query is still running. Poll again later.
  • COMPLETED: The query finished successfully. Results are available.
  • FAILED: The query failed. Check the error message if available.
Available options:
IN_PROGRESS,
COMPLETED,
FAILED
executionId
string

Unique identifier for the query execution. Valid for 7 days. Use this for polling and pagination.

requestId
string

Unique identifier for the HTTP request, useful for support and debugging.

nextPageId
string

Token for retrieving the next page of results. Available as long as the executionId is valid (7 days). If null, there are no more pages available.

totalRowCount
integer<int64>

Total number of rows across all pages (if available).

schema
object[]

Column metadata providing the name and type for each position in the results tuple.