loading

Optimization Tasks | Hitchhikers Platform

Optimization tasks are a list of tasks that you can complete to get the most out of your Yext account — this includes tasks for adding additional content to your entities, as well as linking accounts.

Optimization Tasks API endpoints allow you to retrieve a list of pending tasks, and generate links for users to complete these tasks.

Use Cases
  • Retrieve a link to perform any pending Optimization Tasks given a set of Optimization Tasks and a location.

Optimization Tasks: List

List Optimization Tasks for the account, optionally filtered by task and location.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

taskIds
string

Comma-separated list of Optimization Task IDs corresponding to Optimization Tasks that should be included in the response.

If no IDs are provided, defaults to all available Optimization Tasks in the account.

locationIds
string

Comma-separated list of Location IDs to be used as a filter.

If no IDs are provided, defaults to all Locations in the account.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Optimization Tasks: Get Link

Retrieve a link to perform any pending Optimization Tasks given a set of Optimization Tasks and a location

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

taskIds
string

Comma-separated list of Optimization Task IDs corresponding to Optimization Tasks that should be included in the response.

If no IDs are provided, defaults to all available Optimization Tasks in the account.

locationId
string

Location ID to be used as a filter.

If no ID is provided, defaults to all Locations in the account.

mode
string
Default: "PENDING_ONLY"
Enum: "PENDING_ONLY" "ALL_TASKS" "RESET"

When mode is PENDING_ONLY, the resulting link will only ask the user to complete tasks that are pending or in progress (that have not been completed before).

When mode is ALL_TASKS, the resulting link will show the user all specified tasks for all specified locations, regardless of their status. If a task has been completed, the user is given the option to update the content they entered when completing the task.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}