Get campaign results

Page through poll, ballot and bracket races without listener identities. Each race returns up to 100 tally labels and hasMoreTallies when truncated; its total and the campaign entry count remain full aggregates.

GET/api/v1/campaigns/{token}/results

Authentication

Send your workspace key as xi-api-key or Authorization: Bearer.

campaigns:readread

Parameters

Named placeholders belong in the path. Other arguments use query parameters.

tokenRequired: string
limitOptional: integerRange: 1 to 100
offsetOptional: integerRange: 0 to 100000

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "token": "YOUR_VALUE",
  "limit": 50,
  "offset": 0
}

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-zA-Z0-9_-]+$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "required": [
    "token"
  ],
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "entries": {
      "type": "number"
    },
    "races": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "question": {
            "type": "string"
          },
          "answerId": {
            "type": "string"
          },
          "tallies": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "label": {
                  "type": "string"
                },
                "count": {
                  "type": "number"
                }
              },
              "required": [
                "label",
                "count"
              ],
              "additionalProperties": false
            }
          },
          "total": {
            "type": "number"
          },
          "hasMoreTallies": {
            "type": "boolean"
          }
        },
        "required": [
          "question",
          "answerId",
          "tallies",
          "total",
          "hasMoreTallies"
        ],
        "additionalProperties": false
      }
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "entries",
    "races",
    "limit",
    "offset",
    "hasMore"
  ],
  "additionalProperties": false
}