> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zype.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Consumers

This endpoint will return consumer analytics data for your property.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Analytics (V3)",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "https://analytics.zype.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "api_key",
        "in": "query"
      }
    }
  },
  "security": [
    {
      "api_key": []
    }
  ],
  "paths": {
    "/v3/platform_dynamics/consumers": {
      "get": {
        "x-server-name": "analytics-api",
        "summary": "List Consumers",
        "description": "This endpoint will return consumer analytics data for your property.",
        "tags": [
          "Platform Dynamics"
        ],
        "operationId": "analytics-consumers-v3",
        "parameters": [
          {
            "name": "filters[start_date_gt]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter records created after the specified `start_date` (filters[start_date_gte]=2018-11-01). If no `start_date` is specified, then data returned will date back two weeks ago."
          },
          {
            "name": "filters[start_date_gte]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter records created on or after the specified `start_date`."
          },
          {
            "name": "filters[start_date_lt]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter records created before the specified `start_date`."
          },
          {
            "name": "filters[start_date_lte]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter records created on or before the specified `start_date`."
          },
          {
            "name": "filters[start_date_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter records created on the specified `start_date`. Comparison is date and time specific. If no time values are submitted, 00:00:00 UTC is assumed."
          },
          {
            "name": "interval",
            "in": "query",
            "schema": {
              "type": "string",
              "nullable": true,
              "enum": [
                null,
                "day",
                "week",
                "month",
                "year"
              ]
            },
            "description": "Shortcut method to group records by time intervals. Accepted values: `day`, `week`, `month`, `year`."
          },
          {
            "name": "sort_by",
            "in": "query",
            "schema": {
              "type": "string",
              "nullable": true,
              "enum": [
                null,
                "consumer_id_asc",
                "consumer_id_desc",
                "consumer_email_asc",
                "consumer_email_desc",
                "name_asc",
                "name_desc"
              ]
            },
            "description": "Sort results by value of a specific property + '_' + sort direction (Example - sort_by=start_date_asc, or sort_by=consumer_email_desc)"
          }
        ],
        "responses": {
          "200": {
            "description": "See below for example responses",
            "content": {
              "application/json": {
                "schema": {
                  "title": "ConsumersResponse",
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "title": "ConsumerAnalytics",
                        "type": "object",
                        "properties": {
                          "consumer_id": {
                            "type": "string"
                          },
                          "consumer_email": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "start_date": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1v3~1engagement~1plays/get/responses/422/content/application~1json/schema"
                }
              }
            }
          }
        }
      }
    }
  }
}
```