INinstantly
SuperSearchEnrichment

Get enrichment history

Changed on

Retrieve the enrichment history for a specific resource

Requires one of the following scopes: supersearch_enrichments:read, supersearch_enrichments:all, all:read, all:all

get/api/v2/supersearch-enrichment/history/{resource_id}

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/supersearch-enrichment/history/{resource_id}
  • Auth
    HTTP bearer

Path parameters

resource_idstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

ID of the resource to retrieve

Query parameters

offsetinteger

Number of entries to skip, newest first

limitinteger
Example:10

Maximum number of entries to return; every entry when omitted or 0

Response

Default Response

_idstring required

ID of the history entry

resource_idstring uuid required

ID of the list or campaign the entry belongs to

organization_idstring uuid required

ID of the workspace that owns the resource

reasonstring nullable

What happened to the resource

Example response

[
  {
    "_id": "652f1c2e8b3e4a0012345678",
    "resource_id": "123e4567-e89b-12d3-a456-426614174000",
    "organization_id": "9b2f7c1e-4d3a-4f5b-8c6d-7e8f9a0b1c2d",
    "reason": "Credits deducted: 10 tokens for the enrichment job"
  }
]

Changes

  • c781051105a8Revision changes
    • breaking

      for the query request parameter limit, the type changed from number to integer

    • breaking

      for the query request parameter offset, the type changed from number to integer

    • warning

      for the query request parameter limit, the min was set to 0.00

    • warning

      for the query request parameter offset, the min was set to 0.00

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status