Skip to content
Tx Platform
Create Query Session

Generate the Matching UI🔗︎

This feature has been deprecated.

HTTP Verb Path
POST /ui/v9/matcher/documents
HTTP Verb Path
POST /ui/v9/matcher/indexes/(indexId)/documents/(documentId)
HTTP Verb Path
POST /ui/v9/searcher
HTTP Verb Path
POST /ui/v9/scorer/bimetric

Generate an HTML user interface for matching/searching that can be consumed in your client application.

Info

  • Pagination settings in the SaasRequest such as Take or Skip will be accepted in Search queries, but ignored in Match queries.
  • CustomValueIds can be set in the FilterCriteria and passed through in the background ONLY if there are no CustomValuePicklists specified in the request.

Request Body🔗︎

UIOptions 🔗︎ object

UIOptions🔗︎

Object representing various options for generating the UI.

UIOptions properties

Username 🔗︎ string

Username🔗︎

The username of the current user. *If you do not provide this, the user will be required to login when they view the page.

Style 🔗︎ object

Style🔗︎

Specifies custom style options for this session.

Style properties

PrimaryColor 🔗︎ string

PrimaryColor🔗︎

An HTML color used to generate several related colors for various UI elements. For example: #077799.

HeaderColor 🔗︎ string

HeaderColor🔗︎

An HTML color used for the background of the section/accordian headers. For example: #077799.

SquareCorners 🔗︎ boolean

SquareCorners🔗︎

true to use square corners for UI elements. Default is false for rounded corners.

FontFamily 🔗︎ string

FontFamily🔗︎

A CSS font-family to use for all UI elements. For example: Arial.

FontUrl 🔗︎ string

FontUrl🔗︎

If you'd like to use a non-standard font, specify the URL where that font can be downloaded here. For example: https://fonts.googleapis.com/css2?family=Montserrat:wght@400;500;600;700&display=swap. Note that you also need to define the FontFamily if you use this option.

ShowFilterCriteria 🔗︎ boolean

ShowFilterCriteria🔗︎

Allow the user to see/modify the filter criteria.

FiltersToShow 🔗︎ object[]

FiltersToShow🔗︎

If specified, only allows the user to see/modify certain filter categories. Also, the order specified here is the order in which the filters will appear in the UI.

FiltersToShow properties

FilterId 🔗︎ string required

FilterId🔗︎

One of:

  • JOB_TITLES
  • EXPERIENCE
  • SKILLS
  • INDUSTRIES
  • BOOLEAN
  • LANGUAGES
  • CERTIFICATIONS
  • EXECUTIVE_TYPES
  • LOCATION
  • EDUCATION
  • EMPLOYERS
  • TAGS
  • METADATA
  • UNCOMMON
Title 🔗︎ string

Title🔗︎

An optional value to override the title that is shown for a specific filter. If not specified, the defaults are as below:

  • Job Titles
  • Experience
  • Skills
  • Industries
  • Boolean or Semantic Search
  • Spoken Languages
  • Certifications
  • Executive Types
  • Location
  • Education
  • Employers
  • User-Defined Tags
  • Document Metadata
  • Uncommon Filters
ExecuteImmediately 🔗︎ boolean

ExecuteImmediately🔗︎

Execute the query as soon as the page loads.

ShowBanner 🔗︎ boolean

ShowBanner🔗︎

Show the banner containing your account logo inside the matching UI.

ShowWeights 🔗︎ boolean

ShowWeights🔗︎

Allow the user to see/modify the category weights.

ShowDetailsButton 🔗︎ boolean

ShowDetailsButton🔗︎

Show a button that opens the 'details' popup containing detailed job/resume info.

ShowFindSimilar 🔗︎ boolean

ShowFindSimilar🔗︎

Adds a button in the Actions menu that matches other jobs/resumes similar to the current one.

Hooks 🔗︎ object

Hooks🔗︎

Contains all the User Action Hooks for this session.

Hooks properties

Client 🔗︎ object[]

Client🔗︎

The client-side  User Action Hooks  for this session.

Client properties

LinkText 🔗︎ string

LinkText🔗︎

Text to display on the button for the user action.

IsBulk 🔗︎ boolean

IsBulk🔗︎

Allows users to select multiple documents and perform this action on all of them at once. Note that this can only be set to  true  when you use a JSAction. UrlActions are not supported. See  here  for more info.

UrlAction 🔗︎ object

UrlAction🔗︎

A URL action to perform when the user clicks the button.

UrlAction properties

Url 🔗︎ string

Url🔗︎

The URL to show (either in another tab/window or in an iFrame inside the Matching UI).

Target 🔗︎ string

Target🔗︎

Use tx to open a popup inside the Matching UI and display the webpage. Any other value will be used just like the target attribute on a normal anchor tag (_blank for a new tab/window, etc).

JsAction 🔗︎ object

JsAction🔗︎

A Javascript action to perform when the user clicks the button.

JsAction properties

Target 🔗︎ string

Target🔗︎

One of  parent  or  opener , depending if you use an iFrame to show the Matching UI in your system, or if you open it in a separate tab/window.

TargetOrigin 🔗︎ string

TargetOrigin🔗︎

The 'targetOrigin' parameter for the  window .postMessage() call. For more information see here.

Data 🔗︎ any

Data🔗︎

Any data you want to be sent (in addition to document information) in the 'message' parameter for the  window .postMessage() call. For more information see here.

Server 🔗︎ object[]

Server🔗︎

The server-side (HTTP POST)  User Action Hooks  for this session.

Server properties

LinkText 🔗︎ string

LinkText🔗︎

The text to display on the button for the user action.

Url 🔗︎ string

Url🔗︎

The URL for an HTTP POST call to perform some action in your system.

CustomInfo 🔗︎ any

CustomInfo🔗︎

Any data from your system that you need to associate with this session/action. This is sent (in addition to document information) in the POST body. For more information see here.

IsBulk 🔗︎ boolean

IsBulk🔗︎

Allows users to select multiple documents and perform this action on all of them at once. See here for more info.

OnUpdate 🔗︎ object

OnUpdate🔗︎

This is called when the user makes category weight changes or adds/removes filter criteria and then re-runs the query. You can use these to store user preferences for use on future queries.

OnUpdate properties

Server 🔗︎ object

Server🔗︎

Makes a POST call to the specified URL with the filter/weights data.

Server properties

Url 🔗︎ string

Url🔗︎

The URL for an HTTP POST call to perform some action in your system.

CustomInfo 🔗︎ any

CustomInfo🔗︎

Any data from your system that you need to associate with this session/action. This is sent (in addition to filter criteria and suggested weights) in the POST body. For more information see here.

Client 🔗︎ object

Client🔗︎

Makes a Javscript call via postMessage containing the filter/weights data.

Client properties

Target 🔗︎ string

Target🔗︎

One of  parent  or  opener , depending if you use an iFrame to show the Matching UI in your system, or if you open it in a separate tab/window.

TargetOrigin 🔗︎ string

TargetOrigin🔗︎

The 'targetOrigin' parameter for the  window.postMessage() call. For more information see here.

Data 🔗︎ any

Data🔗︎

Any data you want to be sent (in addition to filter criteria and suggested weights) in the 'message' parameter for the  window.postMessage() call. For more information see here.

CustomValuePicklists 🔗︎ object[]

CustomValuePicklists🔗︎

An array of picklists populated with custom values for users to select from and filter on.

CustomValuePicklists properties

Label 🔗︎ string

Label🔗︎

The label that will appear above the picklist in the UI.

Options 🔗︎ object[]

Options🔗︎

An array of custom values to be used as the options in the picklist.

Options properties

Value 🔗︎ string

Value🔗︎

The value of the custom Id.

Text 🔗︎ string

Text🔗︎

The text that will show in the picklist for the custom Id.

SkillsAutoCompleteCustomSkillsList 🔗︎ string[]

SkillsAutoCompleteCustomSkillsList🔗︎

String[] of your custom skills list names. The builtin Textkernel skills lists are always included.

SaasRequest 🔗︎ object required

SaasRequest🔗︎

The SaaS request that defines the match/search. See the Search & Match and AI Search endpoints for details.

SaasRequest properties

IndexIdsToSearchInto 🔗︎ string[] required

IndexIdsToSearchInto🔗︎

The ids (case-insensitive) of the indexes in which you want to find results. This is the only required value in the SaasRequest.

* 🔗︎ any

*🔗︎

All of the parameters that are supported in the normal Search & Match and AI Search requests are supported, apart from pagination settings for Match queries as noted above.

GeocodeOptions 🔗︎ object

GeocodeOptions🔗︎

All of the parameters that are supported in the normal parsing geocode options requests are supported. See Parse a Resume for more details.

Sample JSON 
{
  "UIOptions": {
    "Username": "",
    "Style": {
      "PrimaryColor": "",
      "HeaderColor": "",
      "SquareCorners": false,
      "FontFamily": "",
      "FontUrl": ""
    },
    "ShowFilterCriteria": true,
    "FiltersToShow": [
      {
        "FilterId": "",
        "Title": ""
      }
    ],
    "ExecuteImmediately": false,
    "ShowBanner": true,
    "ShowWeights": true,
    "ShowDetailsButton": true,
    "ShowFindSimilar": true,
    "Hooks": {
      "Client": [
        {
          "LinkText": "",
          "IsBulk": false,
          "UrlAction": {
            "Url": "",
            "Target": ""
          },
          "JsAction": {
            "Target": "",
            "TargetOrigin": "",
            "Data": {}
          }
        }
      ],
      "Server": [
        {
          "LinkText": "",
          "Url": "",
          "CustomInfo": {},
          "IsBulk": false
        }
      ],
      "OnUpdate": {
        "Server": {
          "Url": "",
          "CustomInfo": {}
        },
        "Client": {
          "Target": "",
          "TargetOrigin": "",
          "Data": {}
        }
      }
    },
    "CustomValuePicklists": [
      {
        "Label": "",
        "Options": [
          {
            "Value": "",
            "Text": ""
          }
        ]
      }
    ],
    "SkillsAutoCompleteCustomSkillsList": [
      ""
    ]
  },
  "SaasRequest": {
    "IndexIdsToSearchInto": [
      ""
    ],
    "*": {}
  },
  "ParseOptions": {
    "Configuration": "",
    "SkillsData": [
      ""
    ],
    "NormalizerData": ""
  },
  "GeocodeOptions": {
    "*": {}
  }
}

Response Body🔗︎

url 🔗︎ string

url🔗︎

The endpoint to hit to get the generated Matching UI. The first request to this endpoint will automatically authenticate the user. Subsequent requests (who are not already authenticated) will require a login. This url will be valid for at least 24 hours.

expires_in 🔗︎ integer

expires_in🔗︎

The number of seconds until the url auto-authentication expires.

Sample JSON 
{
  "url": "",
  "expires_in": 0
}