job/preview

Runs a preview search for a job configuration without saving the job.

Method and path

POST /job/preview

Authentication

Authentication is required. See Authentication.

Permissions

Accessible to tier 1 and 2 users.

Request headers

Header	Required	Description
X-Api-Key or X_API_KEY	yes	API key.
Content-Type	yes	application/json.

Request body

Field	Type	Required	Description
type	string	yes	Job type code.
search	string	no	Search string used by simple search platforms.
searchLang	string	no	Search language code used by some platforms.
search_lang	string	no	Alternate language field used by the wh preview branch.
searchJson	object	no	Structured search object used by composed search platforms.
options	object	no	Additional options. For nfo, supported keys include platforms and language_codes.

Example request

curl -X POST "$SIGNAL_API_BASE_URL/job/preview" \
  -H "X-Api-Key: $SIGNAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "nfo",
    "searchJson": {
      "all": "\"example phrase\"",
      "authors": "example_account"
    }
  }'

{
  "type": "nfo",
  "searchJson": {
    "all": "\"example phrase\"",
    "authors": "example_account"
  },
  "options": {
    "platforms": ["facebook", "instagram"],
    "language_codes": ["it", "en"]
  }
}

Example response

{
  "totalResults": "<total_matches>",
  "posts": [
    {
      "title": "<post_title>",
      "post_text": "<post_text>",
      "full_uri": "<post_url>",
      "platform": "<platform_code>",
      "post_time": "<post_datetime>"
    }
  ]
}

Response fields

Field	Type	Description
totalResults	integer	Total matches returned by the upstream provider.
posts	array<object>	Sample converted posts.

Post object fields

Field	Type	Description
title	string	null
post_text	string	null
full_uri	string	null
platform	string	null
post_time	string	null
Additional fields	mixed	Platform-specific converted fields can be included.

Notes

• The endpoint calls upstream providers directly and returns a converted preview payload.
• Authentication is handled through headers.