Sitemap Integration

Fetch a sitemapIntegration

get/integration/sitemap/{sitemapIntegrationId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/integration/sitemap/{sitemapIntegrationId}/fetch
  • Auth: HTTP bearer

Path parameters

sitemapIntegrationIdstring required

The ID of the Sitemap integration to retrieve

Response

The Sitemap integration was retrieved successfully

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

blueprintIdstring nullable

The ID of the blueprint

datasetIdstring required

The ID of the dataset used in the Sitemap integration

urlstring

The URL to use for this Sitemap integration

globstring

The glob rules to use for this Sitemap integration

selectorsstring

The selector rules to use for this Sitemap integration

javascriptboolean

Indicates if the Sitemap integration should use JavaScript during the spidering process

syncStatus'pending' | 'synced' | 'error'

The sync status of an integration

syncSchedulestring

The sync schedule to use for this Sitemap integration

lastSyncedAtstring date-time

The timestamp of the last successful sync

expiresInnumber

Record expiry in milliseconds

Changes

No recorded changes to this operation across all 1 revision of this API.