Search Location Entities

Options

Body

Search Query Parameters

Request body which must comply to the following JSON Schema:

{
  "required" : [ "field_ids", "query" ],
  "type" : "object",
  "properties" : {
    "field_ids" : {
      "type" : "array",
      "description" : "Fields to include as columns in the search result entities - array of field_id strings",
      "items" : {
        "type" : "string"
      }
    },
    "query" : {
      "type" : "array",
      "description" : "Search query to perform on the designated entity",
      "items" : {
        "required" : [ "field_id", "operator_id", "type" ],
        "type" : "object",
        "properties" : {
          "type" : {
            "required" : [ "predicate" ],
            "type" : "string",
            "description" : "The type of query",
            "enum" : [ "predicate" ]
          },
          "field_id" : {
            "type" : "string",
            "description" : "The field to operate on"
          },
          "operator_id" : {
            "type" : "string",
            "description" : "Description of operators:\n * blank - Blank\n * eq - Equal\n * not_eq - Not equal\n * gt - Greater than\n * gte - Greater than or equal\n * lt - Less than\n * lte - Less than or equal\n * starts - Starts\n * contains - Contains\n * between - Between\n * includes - Includes\n * not_includes - Does not include\n * includes_all - Includes all\n * not_includes_all - Does not include all\n * domain_eq - Domain equals\n * domain_blank - Domain is blank\n",
            "enum" : [ "blank", "eq", "not_eq", "gt", "gte", "lt", "lte", "starts", "contains", "between", "includes", "not_includes", "includes_all", "not_includes_all", "domain_eq", "domain_blank" ]
          },
          "values" : {
            "type" : "array",
            "description" : "values array with data type matching field_id type",
            "items" : {
              "type" : "object"
            }
          }
        },
        "description" : "A simple search criterion"
      }
    },
    "order" : {
      "type" : "array",
      "description" : "Order in which the search results should be returned",
      "items" : {
        "required" : [ "field_id", "sort" ],
        "type" : "object",
        "properties" : {
          "field_id" : {
            "type" : "string",
            "description" : "Name of the field to sort on"
          },
          "sort" : {
            "type" : "string",
            "description" : "Direction of sorting",
            "default" : "asc",
            "enum" : [ "asc", "desc" ]
          },
          "nulls" : {
            "type" : "string",
            "description" : "Whether to include null values at the beginning or end of the sort. Defaults to end.",
            "default" : "last",
            "enum" : [ "first", "last" ]
          }
        }
      }
    },
    "limit" : {
      "type" : "integer",
      "description" : "Number of rows to return. Default is 100, min is 1, max is 2000."
    },
    "before_id" : {
      "type" : "string",
      "description" : "Used to paginate search results to the previous page. before_id should be the uuid of the first item in the current page. May not be provided simultaneously with after_id.",
      "format" : "uuid"
    },
    "after_id" : {
      "type" : "string",
      "description" : "Used to paginate search results to the next page. after_id should be the uuid of the last item in the current page. May not be provided simultaneously with before_id.",
      "format" : "uuid"
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Country Code: Short alphabetic or numeric geographical codes that represent countries (e.g. TWN, USA, ZAF)
  Field Type: text_blob
  Searchable: No
• Country Code Ext: Field Type: text_blob
  Searchable: No
• Created At: Created At
  Field Type: datetime
  Searchable: Yes
  Search Operators: between, blank, eq, gte, lte
• Entity Def Id:

  Field Type: enum
  Searchable: Yes
  Search Operators: blank, eq, includes, not_eq, not_includes
  Possible values are:

  • location - Location
• Facet Ids: Type of location (e.g. City, Continent, Regional Area)
  Field Type: enum_multi
  Searchable: Yes
  Search Operators: blank, includes, includes_all, not_includes, not_includes_all
• Groups: Regional areas this location belongs to (e.g. San Francisco Bay Area, Silicon Valley)
  Field Type: identifier_multi
  Searchable: Yes
  Search Operators: blank, includes, includes_all, not_includes, not_includes_all
• Identifier: Short location name (e.g. Japan, San Francisco, Europe)
  Field Type: identifier
  Searchable: Yes
  Search Operators: blank, contains, eq, includes, not_contains, not_eq, not_includes, starts
• Locations: Full location name (e.g. Denver, Colorado, United States, North America)
  Field Type: identifier_multi
  Searchable: Yes
  Search Operators: blank, includes, includes_all, not_includes, not_includes_all
• Name: Field Type: text_blob
  Searchable: No
• Permalink: Field Type: permalink
  Searchable: No
• Permalink Aliases: These are the alternative aliases to the primary permalink of the Organization
  Field Type: text_exact_multi
  Searchable: Yes
  Search Operators: blank, includes, includes_all, not_includes, not_includes_all
• Region Code: Region code used to define location
  Field Type: text_blob
  Searchable: No
• Short Description: Description
  Field Type: text_long
  Searchable: Yes
  Search Operators: blank, contains, not_contains
• Updated At: Updated At
  Field Type: datetime
  Searchable: Yes
  Search Operators: between, blank, eq, gte, lte
• Uuid: Field Type: uuid
  Searchable: Yes
  Search Operators: blank, eq, includes, not_eq, not_includes

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers