Skip to main content
POST
/
data-api
/
v1
/
async
/
comparison_web_properties_config
Query Comparison Web Properties Configuration (Async)
curl --request POST \
  --url 'https://api-universal.conductor.com/data-api/v1/async/comparison_web_properties_config?apiKey=&sig=' \
  --header 'Content-Type: application/json' \
  --header 'X-API-GATEWAY-KEY: <api-key>' \
  --data '
{
  "account_id": 101
}
'
{
  "results": [
    [
      "456",
      "conductor.com",
      "Business Competitor",
      "[conductor.com]",
      "[conductor.com (GOOGLE_EN_US)]"
    ]
  ],
  "schema": [
    {
      "name": "web_property_id",
      "type": "string"
    },
    {
      "name": "web_property_name",
      "type": "string"
    },
    {
      "name": "attribution_label",
      "type": "string"
    },
    {
      "name": "root_domains",
      "type": "string"
    },
    {
      "name": "compared_against",
      "type": "string"
    }
  ],
  "executionState": "COMPLETED",
  "executionId": "enga:abc12345-1111-2222-3333-444444444444",
  "requestId": "req-123",
  "nextPageId": "87QUIJAKFQ9UIRJklafkg8wyuijFIAOqwfL9UIQOr==",
  "totalRowCount": 1000
}

Documentation Index

Fetch the complete documentation index at: https://conductor.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
apiKey
string
query
required

API Key as a query parameter

​
sig
string
query
required

Request signature computed using API key and secret. Valid for 5 minutes after creation.

​
X-API-GATEWAY-KEY
string
header
required

API Key as an HTTP header (must match apiKey query parameter)

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.