Retrieve a suggestion

curl

curl --request GET \
  --url https://sact.us.algolia.com/2/suggested-actions/fbdf5a53-161e-4460-98ad-0e39408d8689 \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

// Initialize the client
// Replace 'us' with your Algolia Application Region
const client = suggestedActionsClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'us');

// Call the API
const response = await client.getSuggestion({ suggestionID: '76710f1b-8231-42e5-b0d1-f43aac618e15' });


// print the response
console.log(response);

{
  "abTest": {
    "guidedActionSequence": {
      "actions": [
        {
          "description": "<string>",
          "openDashboardPage": {
            "url": "<string>"
          }
        }
      ],
      "description": "<string>"
    }
  },
  "adoptionDetectedAt": "2026-11-09T10:17:47Z",
  "completion": {
    "completedAt": "2026-11-09T10:17:47Z",
    "completedBy": "<string>",
    "source": "SOURCE_UNSPECIFIED"
  },
  "createdAt": "2026-11-09T10:17:47Z",
  "creation": {
    "createdBy": "<string>",
    "source": "SOURCE_UNSPECIFIED"
  },
  "description": "<string>",
  "directAdoption": {
    "guidedActionSequence": {
      "actions": [
        {
          "description": "<string>",
          "openDashboardPage": {
            "url": "<string>"
          }
        }
      ],
      "description": "<string>"
    }
  },
  "dismissedAt": "2026-11-09T10:17:47Z",
  "expiresAt": "2026-11-09T10:17:47Z",
  "id": "<string>",
  "metadata": {},
  "payload": {},
  "provenance": {
    "sources": [
      {
        "evidence": {},
        "id": "<string>",
        "kind": "EVIDENCE_SOURCE_KIND_UNSPECIFIED",
        "observedAt": "2026-11-09T10:17:47Z",
        "version": "<string>"
      }
    ]
  },
  "state": "SUGGESTION_STATE_UNSPECIFIED",
  "target": {
    "appId": "<string>",
    "index": "<string>"
  },
  "title": "<string>",
  "type": "SUGGESTION_TYPE_UNSPECIFIED",
  "withdrawnAt": "2026-11-09T10:17:47Z"
}

{
  "status": 401,
  "message": "Unauthorized."
}

{
  "status": 403,
  "message": "Forbidden."
}

{
  "status": 404,
  "message": "Not found."
}

GET

suggested-actions

{suggestionID}

curl

curl --request GET \
  --url https://sact.us.algolia.com/2/suggested-actions/fbdf5a53-161e-4460-98ad-0e39408d8689 \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

// Initialize the client
// Replace 'us' with your Algolia Application Region
const client = suggestedActionsClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'us');

// Call the API
const response = await client.getSuggestion({ suggestionID: '76710f1b-8231-42e5-b0d1-f43aac618e15' });


// print the response
console.log(response);

{
  "abTest": {
    "guidedActionSequence": {
      "actions": [
        {
          "description": "<string>",
          "openDashboardPage": {
            "url": "<string>"
          }
        }
      ],
      "description": "<string>"
    }
  },
  "adoptionDetectedAt": "2026-11-09T10:17:47Z",
  "completion": {
    "completedAt": "2026-11-09T10:17:47Z",
    "completedBy": "<string>",
    "source": "SOURCE_UNSPECIFIED"
  },
  "createdAt": "2026-11-09T10:17:47Z",
  "creation": {
    "createdBy": "<string>",
    "source": "SOURCE_UNSPECIFIED"
  },
  "description": "<string>",
  "directAdoption": {
    "guidedActionSequence": {
      "actions": [
        {
          "description": "<string>",
          "openDashboardPage": {
            "url": "<string>"
          }
        }
      ],
      "description": "<string>"
    }
  },
  "dismissedAt": "2026-11-09T10:17:47Z",
  "expiresAt": "2026-11-09T10:17:47Z",
  "id": "<string>",
  "metadata": {},
  "payload": {},
  "provenance": {
    "sources": [
      {
        "evidence": {},
        "id": "<string>",
        "kind": "EVIDENCE_SOURCE_KIND_UNSPECIFIED",
        "observedAt": "2026-11-09T10:17:47Z",
        "version": "<string>"
      }
    ]
  },
  "state": "SUGGESTION_STATE_UNSPECIFIED",
  "target": {
    "appId": "<string>",
    "index": "<string>"
  },
  "title": "<string>",
  "type": "SUGGESTION_TYPE_UNSPECIFIED",
  "withdrawnAt": "2026-11-09T10:17:47Z"
}

{
  "status": 401,
  "message": "Unauthorized."
}

{
  "status": 403,
  "message": "Forbidden."
}

{
  "status": 404,
  "message": "Not found."
}

This is a beta feature according to Algolia’s Terms of Service (“Beta Services”).

Required ACL: search

Authorizations

x-algolia-application-id

string

header

required

Your Algolia application ID.

x-algolia-api-key

string

header

required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

suggestionID

string<uuid>

required

Unique identifier of the suggestion.

Response

A recommended action for an application or an index.

abTest

object

Show child attributes

adoptionDetectedAt

string<date-time>

Date and time in RFC 3339 format.

Example:

"2026-11-09T10:17:47Z"

completion

object

Set once the suggestion is completed, whoever completed it.

Show child attributes

createdAt

string<date-time>

Date and time in RFC 3339 format.

Example:

"2026-11-09T10:17:47Z"

creation

object

Show child attributes

description

string

Description of the suggestion.

directAdoption

object

Show child attributes

dismissedAt

string<date-time>

Set when the userId passed to the list request dismissed this suggestion within the dismissal cooldown.

Example:

"2026-11-09T10:17:47Z"

expiresAt

string<date-time>

Date and time in RFC 3339 format.

Example:

"2026-11-09T10:17:47Z"

string

Unique identifier of the suggestion.

metadata

object

Context the creator stored with the suggestion. The service doesn't interpret it.

payload

object

The change the suggestion makes, in the payload format of its type.

provenance

object

Where the evidence for the suggestion comes from.

Show child attributes

state

enum<string>

Lifecycle state of the suggestion.

Available options:

SUGGESTION_STATE_UNSPECIFIED,

ACTIVE,

EXPIRED,

WITHDRAWN,

COMPLETED

target

object

Show child attributes

title

string

Title of the suggestion.

type

enum<string>

Registered definition from which the service derives the suggestion's description and options.

Available options:

SUGGESTION_TYPE_UNSPECIFIED,

ACTIVATE_DYNAMIC_RE_RANKING,

ACTIVATE_PERSONALIZATION,

ACTIVATE_NEURAL_SEARCH,

ACTIVATE_ADVANCED_PERSONALIZATION

withdrawnAt

string<date-time>

Date and time in RFC 3339 format.

Example:

"2026-11-09T10:17:47Z"

Last modified on November 11, 2026