Get extraction field status

GET /campaigns/{id}/extraction-summary

Get extraction field status

cURL

curl --request GET \
  --url https://api.pineyard.ai/campaigns/{id}/extraction-summary \
  --header 'Authorization: Bearer <token>'

200

{
  "keys": [
    {
      "key": "<string>",
      "label": "<string>",
      "type": "<string>",
      "description": "<string>",
      "data": null
    }
  ],
  "status": {
    "done": 123,
    "pending": 123,
    "processing": 123,
    "failed": 123
  },
  "reason": "no_config"
}

Required scope: campaigns.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Response

200

application/json

OK

keys · object[] · required

Show child attributes

status · object | null · required

Show child attributes

reason · enum<string>

Available options: no_config