Skip to main content
POST
/
campaigns
/
entities
Get campaign entities
curl --request POST \
  --url https://backstage.example.com/api/soundcheck/campaigns/entities \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaignId": "<string>",
  "campaignName": "<string>",
  "checkId": "<string>",
  "checkName": "<string>",
  "checkStates": [],
  "entityFilter": {},
  "entityFields": [
    "<string>"
  ],
  "metadataAnnotations": [
    "<string>"
  ],
  "first": 123,
  "after": "<string>"
}
'
{
  "totalCount": 123,
  "pageInfo": {
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "<string>",
    "endCursor": "<string>"
  },
  "edges": [
    {
      "node": {
        "entityRef": "<string>",
        "certified": true,
        "checkStates": [
          {
            "checkId": "<string>",
            "checkName": "<string>"
          }
        ],
        "entity": {}
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://backstage.spotify.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Exactly one of campaignId or campaignName must be provided. If checkStates is provided, checkId or checkName must also be provided.

campaignId
string
campaignName
string
checkId
string
checkName
string
checkStates
enum<string>[]
Available options:
passed,
failed,
warning,
not-applicable
entityFilter
object
entityFields
string[]
metadataAnnotations
string[]
first
integer
after
string

Response

OK

totalCount
integer
required
pageInfo
object
required
edges
object[]
required