Datasources

Get datasource config

Changed on

Fetches the datasource config for the specified custom datasource.

post/api/index/v1/getdatasourceconfig

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/api/index/v1/getdatasourceconfig
  • Auth: HTTP bearer

Request body

datasourcestring required

Datasource name for which config is needed.

Response

OK

namestring required

Unique identifier of datasource instance to which this config applies.

displayNamestring

The user-friendly instance label to display. If omitted, falls back to the title-cased name.

datasourceCategory'UNCATEGORIZED' | 'TICKETS' | 'CRM' | 'PUBLISHED_CONTENT' | 'COLLABORATIVE_CONTENT' | 'QUESTION_ANSWER' | 'MESSAGING' | 'CODE_REPOSITORY' | 'CHANGE_MANAGEMENT' | 'PEOPLE' | 'EMAIL' | 'SSO' | 'ATS' | 'KNOWLEDGE_HUB' | 'EXTERNAL_SHORTCUT' | 'ENTITY' | 'CALENDAR' | 'AGENTS' | 'AI_CONVERSATION' | 'AI_ARTIFACT'

The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to this for more details.

urlRegexstring

Regular expression that matches URLs of documents of the datasource instance. The behavior for multiple matches is non-deterministic. Note: urlRegex is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false). Please add a regex as specific as possible to this datasource instance.

iconUrlstring

The URL to an image to be displayed as an icon for this datasource instance. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).

suggestionTextstring

Example text for what to search for in this datasource

homeUrlstring

The URL of the landing page for this datasource instance. Should point to the most useful page for users, not the company marketing page.

crawlerSeedUrlsstring[]

This only applies to WEB_CRAWL and BROWSER_CRAWL datasources. Defines the seed URLs for crawling.

iconDarkUrlstring

The URL to an image to be displayed as an icon for this datasource instance in dark mode. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).

hideBuiltInFacetsstring[]

List of built-in facet types that should be hidden for the datasource.

redlistTitleRegexstring

A regex that identifies titles that should not be indexed

connectorType'API_CRAWL' | 'BROWSER_CRAWL' | 'BROWSER_HISTORY' | 'BUILTIN' | 'FEDERATED_SEARCH' | 'PUSH_API' | 'WEB_CRAWL' | 'NATIVE_HISTORY'

The source from which document content was pulled, e.g. an API crawl or browser history

renderConfigPresetstring

The name of a render config to use for displaying results from this datasource. Any well known datasource name may be used to render the same as that source, e.g. web or gdrive. Please refer to this for more details

aliasesstring[]

Aliases that can be used as app operator-values.

isOnPremboolean

Whether or not this datasource is hosted on-premise.

trustUrlRegexForViewActivityboolean

True if browser activity is able to report the correct URL for VIEW events. Set this to true if the URLs reported by Chrome are constant throughout each page load. Set this to false if the page has Javascript that modifies the URL during or after the load.

includeUtmSourceboolean

If true, a utm_source query param will be added to outbound links to this datasource within Glean.

stripFragmentInCanonicalUrlboolean

If true, the fragment part of the URL will be stripped when converting to a canonical url.

identityDatasourceNamestring

If the datasource uses another datasource for identity info, then the name of the datasource. The identity datasource must exist already and the datasource with identity info should have its visibility enabled for search results.

productAccessGroupstring

If the datasource uses a specific product access group, then the name of that group.

isUserReferencedByEmailboolean

whether email is used to reference users in document ACLs and in group memberships.

isEntityDatasourceboolean

True if this datasource is used to push custom entities.

isTestDatasourceboolean

True if this datasource will be used for testing purpose only. Documents from such a datasource wouldn't have any effect on search rankings.

Example response

{
  "urlRegex": "https://example-company.datasource.com/.*",
  "quicklinks": [
    {
      "iconConfig": {
        "color": "#343CED",
        "key": "person_icon",
        "iconType": "GLYPH",
        "name": "user"
      }
    }
  ]
}

Changes

  • e6b127133b84Revision changes
    • warning

      added the new AI_ARTIFACT enum value to the //// response property for the response status

    • warning

      added the new AI_ARTIFACT enum value to the ////// response property for the response status

    • warning

      added the new AI_CONVERSATION enum value to the //// response property for the response status

    • warning

      added the new AI_CONVERSATION enum value to the ////// response property for the response status