Analytics_ListAudiences

v1.0.0

Get list of audiences.

Input

{
  "type": "object",
  "properties": {
    "app_name": {
      "type": "string"
    },
    "include_disabled": {
      "type": "boolean"
    },
    "owner_name": {
      "type": "string"
    }
  },
  "required": [
    "app_name",
    "owner_name"
  ],
  "additionalProperties": false
}

Output

{
  "description": "List of audiences.",
  "required": [
    "values"
  ],
  "properties": {
    "nextLink": {
      "type": "string"
    },
    "values": {
      "type": "array",
      "description": "List of audiences.",
      "items": {
        "description": "Audience definition.",
        "properties": {
          "definition": {
            "type": "string",
            "description": "Audience definition in OData format."
          },
          "description": {
            "type": "string",
            "description": "Audience description."
          },
          "estimated_count": {
            "type": "integer",
            "format": "int64",
            "description": "Estimated audience size."
          },
          "name": {
            "type": "string",
            "description": "Audience name."
          },
          "state": {
            "type": "string",
            "description": "Audience state.",
            "enum": [
              "Calculating",
              "Ready",
              "Disabled"
            ]
          }
        }
      }
    }
  }
}