Skip to content
SynupAPI
Get an API key
GETapi.synup.com/api/v4/local-post-ideas/pipeline-status

Local pipeline status

Returns the status of the post-idea generation pipeline for a location — current step, steps completed/remaining, and any error.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Query

NameTypeRequiredDescription
locationIdstringrequiredRelay-encoded location ID.

Headers

NameTypeRequiredDescription
Synup-VersionstringrequiredAPI version date (YYYY-MM-DD).

Request

Request
curl -X GET 'https://api.synup.com/api/v4/local-post-ideas/pipeline-status?locationId=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Responses

StatusDescription
200Successful response
401Unauthorized - Invalid or missing API key
Example response (generated from the schema)
{
  "data": {
    "localPipelineStatus": {
      "id": "string",
      "locationId": 0,
      "pipelineType": "string",
      "status": "string",
      "currentStep": "string",
      "stepsCompleted": [
        "string"
      ],
      "stepsRemaining": [
        "string"
      ],
      "errorMessage": "string",
      "startedAt": "string",
      "completedAt": "string"
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.localPipelineStatusobjectoptional
data.localPipelineStatus.idstringoptional
data.localPipelineStatus.locationIdintegeroptional
data.localPipelineStatus.pipelineTypestringoptional
data.localPipelineStatus.statusstringoptional
data.localPipelineStatus.currentStepstringoptional
data.localPipelineStatus.stepsCompletedarray of stringoptional
data.localPipelineStatus.stepsRemainingarray of stringoptional
data.localPipelineStatus.errorMessagestringoptional
data.localPipelineStatus.startedAtstringoptional
data.localPipelineStatus.completedAtstringoptional