Skip to content

api.md

Latest commit

 

History

History
187 lines (130 loc) · 10.9 KB

api.md

File metadata and controls

187 lines (130 loc) · 10.9 KB
Raw

Parse

Types:

Methods:

  • client.parse.handle(body, { ...params }) -> ParseHandleResponse

Web

Types:

Methods:

  • client.web.answers({ ...params }) -> WebAnswersResponse
  • client.web.extractCompetitors({ ...params }) -> WebExtractCompetitorsResponse
  • client.web.extractStyleguide({ ...params }) -> WebExtractStyleguideResponse
  • client.web.mapUrls({ ...params }) -> WebMapURLsResponse
  • client.web.scrape({ ...params }) -> WebScrapeResponse
  • client.web.screenshot({ ...params }) -> WebScreenshotResponse
  • client.web.search({ ...params }) -> WebSearchResponse
  • client.web.webCrawlMd({ ...params }) -> WebWebCrawlMdResponse

Brand

Types:

Methods:

  • client.brand.retrieve({ ...params }) -> BrandRetrieveResponse
  • client.brand.search({ ...params }) -> BrandSearchResponse

Industry

Types:

Methods:

  • client.industry.retrieveNaics({ ...params }) -> IndustryRetrieveNaicsResponse
  • client.industry.retrieveSic({ ...params }) -> IndustryRetrieveSicResponse

Utility

Types:

Methods:

  • client.utility.prefetch({ ...params }) -> UtilityPrefetchResponse

Monitors

Types:

Methods:

  • client.monitors.create({ ...params }) -> MonitorCreateResponse
  • client.monitors.retrieve(monitorID) -> MonitorRetrieveResponse
  • client.monitors.update(monitorID, { ...params }) -> MonitorUpdateResponse
  • client.monitors.list({ ...params }) -> MonitorListResponse
  • client.monitors.delete(monitorID) -> MonitorDeleteResponse
  • client.monitors.getCreditUsage({ ...params }) -> MonitorGetCreditUsageResponse
  • client.monitors.getLimits() -> MonitorGetLimitsResponse
  • client.monitors.listAccountChanges({ ...params }) -> MonitorListAccountChangesResponse
  • client.monitors.listAccountRuns({ ...params }) -> MonitorListAccountRunsResponse
  • client.monitors.listChanges(monitorID, { ...params }) -> MonitorListChangesResponse
  • client.monitors.listRuns(monitorID, { ...params }) -> MonitorListRunsResponse
  • client.monitors.retrieveChange(changeID) -> MonitorRetrieveChangeResponse
  • client.monitors.retrieveRun(runID, { ...params }) -> MonitorRetrieveRunResponse
  • client.monitors.rotateWebhookSecret(monitorID) -> MonitorRotateWebhookSecretResponse
  • client.monitors.run(monitorID) -> MonitorRunResponse

Batch

Types:

Methods:

  • client.batch.retrieve(batchID) -> BatchRetrieveResponse
  • client.batch.list({ ...params }) -> BatchListResponse
  • client.batch.delete(batchID) -> BatchDeleteResponse
  • client.batch.cancel(batchID) -> BatchCancelResponse
  • client.batch.getResults(batchID, { ...params }) -> BatchGetResultsResponse
  • client.batch.submit({ ...params }) -> BatchSubmitResponse

Webhooks

Types:

Deliveries

Types:

Methods:

  • client.webhooks.deliveries.retrieve(deliveryID, { ...params }) -> DeliveryRetrieveResponse
  • client.webhooks.deliveries.list({ ...params }) -> DeliveryListResponse
  • client.webhooks.deliveries.listAttempts(deliveryID, { ...params }) -> DeliveryListAttemptsResponse
  • client.webhooks.deliveries.retry(deliveryID, { ...params }) -> DeliveryRetryResponse

People

Types:

Methods:

  • client.people.enrich({ ...params }) -> PersonEnrichResponse

News

Types:

Methods:

  • client.news.search({ ...params }) -> NewsSearchResponse

Logs

Types:

Methods:

  • client.logs.retrieve(requestID) -> LogRetrieveResponse
  • client.logs.list({ ...params }) -> LogListResponse