HighLevel: Get crawling status for the latest operation

← Knowledge base operations · Get started

Operation gohighlevel.getcrawlingstatusforlatestoperation

Provider route: GET /knowledge-bases/crawler/status. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["knowledgeBase"]["getCrawlingStatusForLatestOperation"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.knowledgeBase.getCrawlingStatusForLatestOperation(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.knowledge_base.get_crawling_status_for_latest_operation(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Required within parent
query.operationId	string	Required within parent
query.knowledgeBaseId	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get crawling status for the latest operation — response body

Referenced models: Get crawling status for the latest operation — response body

Schemas

Get crawling status for the latest operation — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Detailed crawling status data
data (allOf 1)	Model	All variants apply	Expand Get crawling status for the latest operation — response body — data aggregate, operation Details
success	boolean	Required within parent	Indicates if the operation was successful

Referenced models: Get crawling status for the latest operation — response body — data aggregate, operation Details

Get crawling status for the latest operation — response body — data aggregate, operation Details

Field	Type	Presence	Description and constraints
$	object	Root
aggregate	array	Required within parent	Aggregated crawling results by status
aggregate[]	Model	Each item	Expand Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item
operationDetails	JSON	Required within parent	Detailed operation information
operationDetails (allOf 1)	Model	All variants apply	Expand Get crawling status for the latest operation — response body — data / aggregate, operationDetails / operationDetails / mode: Exact, Path, Domain

Referenced models: Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item, Get crawling status for the latest operation — response body — data / aggregate, operationDetails / operationDetails / mode: Exact, Path, Domain

Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Status grouping identifier Known values: Pending, Processing, Successful, Failed, Existing, Restricted, Cancelled, Aborted, Training
records	array	Required within parent	Array of records for this status
records[]	Model	Each item	Expand Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item

Referenced models: Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item

Get crawling status for the latest operation — response body — data / aggregate, operationDetails / operationDetails / mode: Exact, Path, Domain

Field	Type	Presence	Description and constraints
$	object	Root
__v	JSON	Required within parent
__v (anyOf 1)	number	Alternative	Version field
__v (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
_id	string	Required within parent	Operation unique identifier
createdAt	string	Required within parent	Operation creation timestamp
discoveredUrlsCount	JSON	Required within parent
discoveredUrlsCount (anyOf 1)	number	Alternative	Number of URLs discovered
discoveredUrlsCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
knowledgeBaseId	string	Required within parent	Knowledge base ID
locationId	string	Required within parent	Associated location ID
mode	string	Required within parent	Crawling mode used Known values: Exact, Path, Domain
robotsFileData	string	Optional	Robots.txt file content
status	string	Required within parent	Current operation status Known values: Pending, Processing, Successful, Failed, Existing, Restricted, Cancelled, Aborted, Training
trainedUrlsCount	JSON	Required within parent
trainedUrlsCount (anyOf 1)	number	Alternative	Number of URLs successfully trained
trainedUrlsCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	Last update timestamp
url	string	Required within parent	Base URL being crawled

Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item

Field	Type	Presence	Description and constraints
$	object	Root
error	JSON	Optional	Error details (for failed records)
error (allOf 1)	Model	All variants apply	Expand Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item error message, name, options, response, stack, status
id	string	Required within parent	Unique record identifier
title	string	Optional	Page title (for successful/pending records)
url	string	Required within parent	URL being crawled

Referenced models: Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item error message, name, options, response, stack, status

Get crawling status for the latest operation — response body — data aggregate, operation Details aggregate item records item error message, name, options, response, stack, status

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Error message
name	string	Required within parent	Error name/type
options	object	Optional	Additional options (nullable)
response	string	Required within parent	Error response message
stack	string	Required within parent	Error stack trace
status	JSON	Required within parent
status (anyOf 1)	number	Alternative	HTTP status code
status (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: gohighlevel.getcrawlingstatusforlatestoperation. Catalog operation: getCrawlingStatusForLatestOperation. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Version": "v3"}

Official provider source