Retrieve your connection specs

The first step in filtering row-level data for your source is to retrieve your source’s connection specs and determine the operators and language that your source supports.

To retrieve a given source’s connection spec, make a GET request to the /connectionSpecs endpoint of the Flow Service API and providing the property name of your source as part of your query parameters.

API format

GET /connectionSpecs/{QUERY_PARAMS}
ParameterDescription
{QUERY_PARAMS}The optional query parameters to filter results by. You can retrieve the Google BigQuery connection spec by applying the name property and specifying "google-big-query" in your search.
Request

The following request retrieves the connection specs for Google BigQuery.

curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="google-big-query"' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
Response

A successful response returns the status code 200 and the connection specs for Google BigQuery, including information on its supported query language and logical operators.

"attributes": {
  "filterAtSource": {
    "enabled": true,
    "queryLanguage": "SQL",
    "logicalOperators": [
      "and",
      "or",
      "not"
    ],
    "comparisonOperators": [
      "=",
      "!=",
      "<",
      "<=",
      ">",
      ">=",
      "like",
      "in"
    ],
    "columnNameEscapeChar": "`",
    "valueEscapeChar": "'"
  }
PropertyDescription
attributes.filterAtSource.enabledDetermines whether the queried source supports filtering for row-level data.
attributes.filterAtSource.queryLanguageDetermines the query language that the queried source supports.
attributes.filterAtSource.logicalOperatorsDetermines the logical operators that you can use to filter row-level data for your source.
attributes.filterAtSource.comparisonOperatorsDetermines comparison operators that you can use to filter row-level data for your source. See the table below for more information on comparison operators.
attributes.filterAtSource.columnNameEscapeCharDetermines the character to use to escape columns.
attributes.filterAtSource.valueEscapeCharDetermines how values will be surrounded when writing an SQL query.