> ## 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 Playout Hours

This endpoint to retrieve hours requested data for Playout Channels. This allows customers who are distributing Playout Channels where Zype supports the delivery to measure and track detailed information related to their Playout Channel hours requested.

# 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/playout_hours": {
      "get": {
        "x-server-name": "analytics-api",
        "summary": "List Playout Hours",
        "description": "This endpoint to retrieve hours requested data for Playout Channels. This allows customers who are distributing Playout Channels where Zype supports the delivery to measure and track detailed information related to their Playout Channel hours requested.",
        "tags": [
          "Platform Dynamics"
        ],
        "operationId": "playoutHours",
        "parameters": [
          {
            "name": "filters[start_date_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter records created on the specified `start_date` (UTC).(filters[start_date_eq]=2020-07-01). A start date is required when making a data request."
          },
          {
            "name": "filters[video_id_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the Video ID."
          },
          {
            "name": "filters[channel_id_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the Playout Channel ID. Use the Zype platform channel ID to filter records for a specific Playout channel."
          },
          {
            "name": "filters[partner_id_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the Playout partner ID. Supported values are `pluto_tv`, `samsung_tv`"
          },
          {
            "name": "filters[playlist_id_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the Zype Playlist ID."
          },
          {
            "name": "filters[country_code_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by 2 character country code. (filters[country_code_eq]=US)"
          },
          {
            "name": "filters[device_name_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the device name."
          },
          {
            "name": "filters[dma_code_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the DMA code. (filters[dma_code_eq]=501)"
          },
          {
            "name": "filters[city_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the City. (filters[city_eq]=New York)"
          },
          {
            "name": "filters[state_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the State. (filters[state_eq]=New York)"
          },
          {
            "name": "filters[zip_code_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by Zip Code."
          },
          {
            "name": "filters[client_ip_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the Client IP address."
          },
          {
            "name": "filters[user_agent_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by User Agent string."
          },
          {
            "name": "filters[session_id_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter by the Session ID."
          },
          {
            "name": "filters[region_eq]",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Filter query by region. Using this overrides the region param and is more granular. -- Accepted regions are: `US`, `EU`, `AP`."
          },
          {
            "name": "group_by",
            "in": "query",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "nullable": true,
                "enum": [
                  null,
                  "all",
                  "video_id",
                  "channel_id",
                  "partner_id",
                  "country_code",
                  "device_name",
                  "region"
                ]
              }
            },
            "description": "Group records by one or more properties of the data returned -- accepted values are: `all`, `video_id`, `channel_id`, `partner_id`, `country_code`, `device_name`, `region`."
          },
          {
            "name": "email_address",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Required when group_by is set to \"all\". Results will be delivered as downloadable CSV links via email."
          },
          {
            "name": "region",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "US",
                "EU"
              ],
              "default": "US"
            },
            "description": "Select Playout Analytics Region to query -- default is US."
          }
        ],
        "responses": {
          "200": {
            "description": "See below for example responses",
            "content": {
              "application/json": {
                "schema": {
                  "title": "PlayoutHoursResponse",
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "title": "PlayoutHour",
                        "type": "object",
                        "properties": {
                          "video_id": {
                            "type": "string"
                          },
                          "channel_id": {
                            "type": "string"
                          },
                          "partner_id": {
                            "type": "string"
                          },
                          "playout_hours": {
                            "type": "number"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```