jupyter_notebooks/querying_the_barb_api_using_python.ipynb

{
 "cells": [
  {
   "attachments": {},
   "cell_type": "markdown",
   "id": "3ac80477-f4ab-47ab-8225-1848acdc85bd",
   "metadata": {},
   "source": [
    "# Query the Barb API using python\n",
    "\n",
    "In this demo we will show you how to query the Barb API using Python. We will do this first without making use of the pybarb package (as you may wish to develop your own software from scratch). We will then show you how to use the pybarb package to make the same query.\n",
    "\n",
    "Note the full API documentation can be found [here](https://barb-api.co.uk/api-docs). \n",
    "\n",
    "It might also be useful to consult the [Getting Started](https://barb-api.co.uk/api-docs#section/Getting-started) section for information about authentication and basic API usage."
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "id": "71b57700-2491-4fdc-9cf6-c23e6c93a501",
   "metadata": {},
   "source": [
    "## Querying the API without pybarb\n",
    "\n",
    "First we use the code and instructions from the notebook \"Connecting to the BARB API using Python\" to connect to the API."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "5b8df422-cc3d-4ba6-8b56-9ea09ec861ff",
   "metadata": {},
   "outputs": [],
   "source": [
    "import requests\n",
    "import json\n",
    "\n",
    "# Set the working directory\n",
    "working_directory = '/path/to/your/dir/'\n",
    "\n",
    "# Get the access token\n",
    "with open(working_directory + \"creds.json\") as file:\n",
    "    creds = json.load(file)\n",
    "api_root = \"https://barb-api.co.uk/api/v1/\"\n",
    "token_request_url = api_root + \"auth/token/\"\n",
    "response = requests.post(token_request_url, data = creds)\n",
    "access_token = json.loads(response.text)['access']\n",
    "\n",
    "# Set the headers\n",
    "headers = {'Authorization': 'Bearer {}'.format(access_token)}\n"
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "id": "da9fe2fd-238a-4c6e-9d4d-9f3ce2b377dd",
   "metadata": {},
   "source": [
    "We now have everything we need to query the BARB API. Let's start by getting the programme ratings for all programmes broadcast on BBC One to the BBC Network panel between 25th and 31st December 2022. \n",
    "\n",
    "We use [the endpoint documentation](https://barb-api.co.uk/api-docs#tag/Events/operation/ProgrammeRatings) to understand which query parameters can be used and what values they can take. We set the parameters for the query as follows:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "cb227b11",
   "metadata": {},
   "outputs": [],
   "source": [
    "params = {\"min_transmission_date\": \"2022-12-25\",\"max_transmission_date\":\"2022-12-31\", \n",
    "          \"station_code\": 10, \n",
    "          \"panel_code\": 50,\n",
    "         \"consolidated\": True, \"limit\": 5000}"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "816a2a48",
   "metadata": {},
   "source": [
    "Now we can query the endpoint by passing it the parameters and the headers we just created. We will use the requests library to do this. We will also use the json library to format the response as a JSON object."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "97df138b",
   "metadata": {},
   "outputs": [],
   "source": [
    "api_url = api_root + \"programme_ratings/\"\n",
    "r = requests.get(url=api_url, params=params, headers=headers)\n",
    "api_data = r.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "bc7b3238",
   "metadata": {},
   "source": [
    "The data has a nested structure which is explained in the API documentation. "
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f9ca3d61",
   "metadata": {},
   "source": [
    "This data can be flattened using the json_normalize() function from the pandas library. This function takes a JSON object and flattens it into a pandas DataFrame. "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "b64333ae",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>transmission_log_programme_name</th>\n",
       "      <th>programme_type</th>\n",
       "      <th>programme_duration</th>\n",
       "      <th>spans_normal_day</th>\n",
       "      <th>broadcaster_transmission_code</th>\n",
       "      <th>live_status</th>\n",
       "      <th>uk_premier</th>\n",
       "      <th>broadcaster_premier</th>\n",
       "      <th>repeat</th>\n",
       "      <th>platforms</th>\n",
       "      <th>...</th>\n",
       "      <th>programme_content.content_name</th>\n",
       "      <th>programme_content.barb_content_id</th>\n",
       "      <th>programme_content.broadcaster_content_id</th>\n",
       "      <th>programme_content.metabroadcast_information.metabroadcast_content_id</th>\n",
       "      <th>programme_content.episode.episode_number</th>\n",
       "      <th>programme_content.episode.episode_name</th>\n",
       "      <th>programme_content.series.series_number</th>\n",
       "      <th>programme_content.series.number_of_episodes</th>\n",
       "      <th>programme_content.series.broadcaster_series_id</th>\n",
       "      <th>programme_content.genre</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>MICHAEL MCINTYRE'S CHRISTMAS WHEEL</td>\n",
       "      <td>programme</td>\n",
       "      <td>57</td>\n",
       "      <td>False</td>\n",
       "      <td>15056800065812</td>\n",
       "      <td>unknown</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>[Analogue Terrestrial, Digital Terrestrial, An...</td>\n",
       "      <td>...</td>\n",
       "      <td>Michael McIntyre's The Wheel: Series 3, Episode 7</td>\n",
       "      <td>7398800</td>\n",
       "      <td>m001gnjd</td>\n",
       "      <td>p9jg8r</td>\n",
       "      <td>7</td>\n",
       "      <td>Christmas Special</td>\n",
       "      <td>3</td>\n",
       "      <td>12</td>\n",
       "      <td>None</td>\n",
       "      <td>Entertainment</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>SUPERWORM</td>\n",
       "      <td>programme</td>\n",
       "      <td>25</td>\n",
       "      <td>False</td>\n",
       "      <td>31485693446812</td>\n",
       "      <td>unknown</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>[Analogue Terrestrial, Digital Terrestrial, An...</td>\n",
       "      <td>...</td>\n",
       "      <td>FILM: Superworm (2021)</td>\n",
       "      <td>6140411</td>\n",
       "      <td>m0012w40</td>\n",
       "      <td>pjtpcs</td>\n",
       "      <td>0</td>\n",
       "      <td>Superworm</td>\n",
       "      <td>(2021)</td>\n",
       "      <td>0</td>\n",
       "      <td>None</td>\n",
       "      <td>Films</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>EastEnders</td>\n",
       "      <td>programme</td>\n",
       "      <td>59</td>\n",
       "      <td>False</td>\n",
       "      <td>11875724298812</td>\n",
       "      <td>unknown</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>[Analogue Terrestrial, Digital Terrestrial, An...</td>\n",
       "      <td>...</td>\n",
       "      <td>EastEnders: Series 2022</td>\n",
       "      <td>7398806</td>\n",
       "      <td>m001gnjl</td>\n",
       "      <td>p9jg8v</td>\n",
       "      <td>0</td>\n",
       "      <td>25/12/2022</td>\n",
       "      <td>(2022)</td>\n",
       "      <td>0</td>\n",
       "      <td>None</td>\n",
       "      <td>Drama</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>MRS BROWN'S BOYS CHRISTMAS SPECIAL</td>\n",
       "      <td>programme</td>\n",
       "      <td>29</td>\n",
       "      <td>False</td>\n",
       "      <td>14320869134812</td>\n",
       "      <td>unknown</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>[Analogue Terrestrial, Digital Terrestrial, An...</td>\n",
       "      <td>...</td>\n",
       "      <td>Mrs Brown's Boys: Series 18, Episode 1</td>\n",
       "      <td>7398804</td>\n",
       "      <td>m001gnjn</td>\n",
       "      <td>p9jg8w</td>\n",
       "      <td>1</td>\n",
       "      <td>Shining Mammy</td>\n",
       "      <td>18</td>\n",
       "      <td>2</td>\n",
       "      <td>None</td>\n",
       "      <td>Entertainment</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>GHOSTS CHRISTMAS SPECIAL</td>\n",
       "      <td>programme</td>\n",
       "      <td>30</td>\n",
       "      <td>False</td>\n",
       "      <td>19147778551812</td>\n",
       "      <td>unknown</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>[Analogue Terrestrial, Digital Terrestrial, An...</td>\n",
       "      <td>...</td>\n",
       "      <td>Ghosts: Series 2022</td>\n",
       "      <td>7398770</td>\n",
       "      <td>m001gnjg</td>\n",
       "      <td>p9jg8s</td>\n",
       "      <td>0</td>\n",
       "      <td>It's Behind You</td>\n",
       "      <td>(2022)</td>\n",
       "      <td>0</td>\n",
       "      <td>None</td>\n",
       "      <td>Entertainment</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>5 rows × 31 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "      transmission_log_programme_name programme_type  programme_duration  \\\n",
       "0  MICHAEL MCINTYRE'S CHRISTMAS WHEEL      programme                  57   \n",
       "1                           SUPERWORM      programme                  25   \n",
       "2                          EastEnders      programme                  59   \n",
       "3  MRS BROWN'S BOYS CHRISTMAS SPECIAL      programme                  29   \n",
       "4            GHOSTS CHRISTMAS SPECIAL      programme                  30   \n",
       "\n",
       "   spans_normal_day broadcaster_transmission_code live_status  uk_premier  \\\n",
       "0             False                15056800065812     unknown        True   \n",
       "1             False                31485693446812     unknown       False   \n",
       "2             False                11875724298812     unknown        True   \n",
       "3             False                14320869134812     unknown        True   \n",
       "4             False                19147778551812     unknown        True   \n",
       "\n",
       "   broadcaster_premier  repeat  \\\n",
       "0                 True   False   \n",
       "1                False    True   \n",
       "2                 True   False   \n",
       "3                 True   False   \n",
       "4                 True   False   \n",
       "\n",
       "                                           platforms  ...  \\\n",
       "0  [Analogue Terrestrial, Digital Terrestrial, An...  ...   \n",
       "1  [Analogue Terrestrial, Digital Terrestrial, An...  ...   \n",
       "2  [Analogue Terrestrial, Digital Terrestrial, An...  ...   \n",
       "3  [Analogue Terrestrial, Digital Terrestrial, An...  ...   \n",
       "4  [Analogue Terrestrial, Digital Terrestrial, An...  ...   \n",
       "\n",
       "                      programme_content.content_name  \\\n",
       "0  Michael McIntyre's The Wheel: Series 3, Episode 7   \n",
       "1                             FILM: Superworm (2021)   \n",
       "2                            EastEnders: Series 2022   \n",
       "3             Mrs Brown's Boys: Series 18, Episode 1   \n",
       "4                                Ghosts: Series 2022   \n",
       "\n",
       "   programme_content.barb_content_id programme_content.broadcaster_content_id  \\\n",
       "0                            7398800                                 m001gnjd   \n",
       "1                            6140411                                 m0012w40   \n",
       "2                            7398806                                 m001gnjl   \n",
       "3                            7398804                                 m001gnjn   \n",
       "4                            7398770                                 m001gnjg   \n",
       "\n",
       "   programme_content.metabroadcast_information.metabroadcast_content_id  \\\n",
       "0                                             p9jg8r                      \n",
       "1                                             pjtpcs                      \n",
       "2                                             p9jg8v                      \n",
       "3                                             p9jg8w                      \n",
       "4                                             p9jg8s                      \n",
       "\n",
       "   programme_content.episode.episode_number  \\\n",
       "0                                         7   \n",
       "1                                         0   \n",
       "2                                         0   \n",
       "3                                         1   \n",
       "4                                         0   \n",
       "\n",
       "  programme_content.episode.episode_name  \\\n",
       "0                      Christmas Special   \n",
       "1                              Superworm   \n",
       "2                             25/12/2022   \n",
       "3                          Shining Mammy   \n",
       "4                        It's Behind You   \n",
       "\n",
       "  programme_content.series.series_number  \\\n",
       "0                                      3   \n",
       "1                                 (2021)   \n",
       "2                                 (2022)   \n",
       "3                                     18   \n",
       "4                                 (2022)   \n",
       "\n",
       "  programme_content.series.number_of_episodes  \\\n",
       "0                                          12   \n",
       "1                                           0   \n",
       "2                                           0   \n",
       "3                                           2   \n",
       "4                                           0   \n",
       "\n",
       "  programme_content.series.broadcaster_series_id programme_content.genre  \n",
       "0                                           None           Entertainment  \n",
       "1                                           None                   Films  \n",
       "2                                           None                   Drama  \n",
       "3                                           None           Entertainment  \n",
       "4                                           None           Entertainment  \n",
       "\n",
       "[5 rows x 31 columns]"
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "from pandas import json_normalize\n",
    "json_normalize(api_data['events']).head()\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ecb9f81e",
   "metadata": {},
   "source": [
    "If the dataset is large then it will be returned over multiple pages. To return all the data we need to loop through the pages and append the data to a list. The following code will return all the data for the last half of 2022."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "55309433-0176-4ce7-aebe-0897071ea01f",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Downloading the next page from https://barb-api.co.uk/api/v1/programme_ratings/?consolidated=True&limit=5000&max_transmission_date=2022-12-31&min_transmission_date=2022-07-01&panel_code=50&start_from_id=13621655&station_code=10\n",
      "Downloading the next page from https://barb-api.co.uk/api/v1/programme_ratings/?consolidated=True&limit=5000&max_transmission_date=2022-12-31&min_transmission_date=2022-07-01&panel_code=50&start_from_id=33651175&station_code=10\n"
     ]
    }
   ],
   "source": [
    "api_url = api_root + \"programme_ratings/\"\n",
    "\n",
    "# The query parameters\n",
    "params = {\"min_transmission_date\": \"2022-07-01\",\"max_transmission_date\":\"2022-12-31\", \n",
    "          \"station_code\": 10, \n",
    "          \"panel_code\": 50,\n",
    "         \"consolidated\": True, \"limit\": 5000}\n",
    "\n",
    "# Query the API and turn the response into json\n",
    "api_data = []\n",
    "r = requests.get(url=api_url, params=params, headers=headers)\n",
    "api_data.append(r.json())\n",
    "\n",
    "while r.headers.__contains__(\"X-Next\"):\n",
    "    print(f'Downloading the next page from {r.headers[\"X-Next\"]}')\n",
    "    x_next_url = r.headers[\"X-Next\"]\n",
    "    r = requests.get(url=x_next_url, headers=headers)\n",
    "    api_data.append(r.json())\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "eddc8140",
   "metadata": {},
   "source": [
    "However to properly assemble a table of audience data we need to join the `event` data with the `audience_categories` data. This is straightforward to do using the `merge()` function from the pandas library, however the pybarb package handles all of this for you."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "e1a2f0cd",
   "metadata": {},
   "source": [
    "## Querying the API with pybarb\n",
    "\n",
    "First we connect to the API using the `pybarb` package as described in \"Connecting to the Barb API using Python\". "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "1d9c1dfe",
   "metadata": {},
   "outputs": [],
   "source": [
    "import pybarb as pb\n",
    "\n",
    "# Create a BarbAPI object and connect\n",
    "barb_api = pb.BarbAPI(creds)\n",
    "barb_api.connect()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "53c8c906",
   "metadata": {},
   "source": [
    "Now we can use `programme_ratings` method to query the programme ratings endpoint. This method will handle the pagination for us."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "5d9ac66f",
   "metadata": {},
   "outputs": [],
   "source": [
    "bbc_1_progs = barb_api.programme_ratings(min_transmission_date = \"2022-12-25\", \n",
    "                           max_transmission_date = \"2022-12-31\", \n",
    "                           station=\"BBC1\", panel=\"bbc network\", \n",
    "                           consolidated=True)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1bd7a71b",
   "metadata": {},
   "source": [
    "The downloaded data can be viewed in the `api_response_data` attribute."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1a468d4d",
   "metadata": {},
   "source": [
    "However it is much more convenient to use the `to_dataframe` method to convert the response to a pandas dataframe. This method will also do things like convert the dates to datetime objects and merge the `event` data with the `audience_categories` data.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "915e9aea",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>panel_region</th>\n",
       "      <th>station_name</th>\n",
       "      <th>programme_name</th>\n",
       "      <th>programme_type</th>\n",
       "      <th>programme_start_datetime</th>\n",
       "      <th>programme_duration_minutes</th>\n",
       "      <th>spans_normal_day</th>\n",
       "      <th>uk_premiere</th>\n",
       "      <th>broadcaster_premiere</th>\n",
       "      <th>programme_repeat</th>\n",
       "      <th>episode_number</th>\n",
       "      <th>episode_name</th>\n",
       "      <th>genre</th>\n",
       "      <th>audience_name</th>\n",
       "      <th>audience_size_hundreds</th>\n",
       "      <th>audience_target_size_hundreds</th>\n",
       "      <th>date_of_transmission</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>BBC Network</td>\n",
       "      <td>BBC1</td>\n",
       "      <td>Michael McIntyre's The Wheel: Series 3, Episode 7</td>\n",
       "      <td>programme</td>\n",
       "      <td>2022-12-25 18:25:43</td>\n",
       "      <td>57</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>7</td>\n",
       "      <td>Christmas Special</td>\n",
       "      <td>Entertainment</td>\n",
       "      <td>All Homes</td>\n",
       "      <td>28849</td>\n",
       "      <td>272070</td>\n",
       "      <td>2022-12-25</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>BBC Network</td>\n",
       "      <td>BBC1</td>\n",
       "      <td>Michael McIntyre's The Wheel: Series 3, Episode 7</td>\n",
       "      <td>programme</td>\n",
       "      <td>2022-12-25 18:25:43</td>\n",
       "      <td>57</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>7</td>\n",
       "      <td>Christmas Special</td>\n",
       "      <td>Entertainment</td>\n",
       "      <td>All Adults</td>\n",
       "      <td>55235</td>\n",
       "      <td>514750</td>\n",
       "      <td>2022-12-25</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>BBC Network</td>\n",
       "      <td>BBC1</td>\n",
       "      <td>Michael McIntyre's The Wheel: Series 3, Episode 7</td>\n",
       "      <td>programme</td>\n",
       "      <td>2022-12-25 18:25:43</td>\n",
       "      <td>57</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>7</td>\n",
       "      <td>Christmas Special</td>\n",
       "      <td>Entertainment</td>\n",
       "      <td>All Men</td>\n",
       "      <td>21919</td>\n",
       "      <td>250780</td>\n",
       "      <td>2022-12-25</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>BBC Network</td>\n",
       "      <td>BBC1</td>\n",
       "      <td>Michael McIntyre's The Wheel: Series 3, Episode 7</td>\n",
       "      <td>programme</td>\n",
       "      <td>2022-12-25 18:25:43</td>\n",
       "      <td>57</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>7</td>\n",
       "      <td>Christmas Special</td>\n",
       "      <td>Entertainment</td>\n",
       "      <td>All Houseperson</td>\n",
       "      <td>31321</td>\n",
       "      <td>272070</td>\n",
       "      <td>2022-12-25</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>BBC Network</td>\n",
       "      <td>BBC1</td>\n",
       "      <td>Michael McIntyre's The Wheel: Series 3, Episode 7</td>\n",
       "      <td>programme</td>\n",
       "      <td>2022-12-25 18:25:43</td>\n",
       "      <td>57</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>True</td>\n",
       "      <td>False</td>\n",
       "      <td>7</td>\n",
       "      <td>Christmas Special</td>\n",
       "      <td>Entertainment</td>\n",
       "      <td>All Children aged 4-15</td>\n",
       "      <td>5348</td>\n",
       "      <td>95890</td>\n",
       "      <td>2022-12-25</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>24835</th>\n",
       "      <td>BBC Network</td>\n",
       "      <td>BBC1</td>\n",
       "      <td>Weather for the Week Ahead: Series 2022</td>\n",
       "      <td>programme</td>\n",
       "      <td>2023-01-01 03:14:33</td>\n",
       "      <td>3</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>0</td>\n",
       "      <td>01/01/2023</td>\n",
       "      <td>Weather</td>\n",
       "      <td>Adults, Lightest Third</td>\n",
       "      <td>0</td>\n",
       "      <td>171580</td>\n",
       "      <td>2023-01-01</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>24836</th>\n",
       "      <td>BBC Network</td>\n",
       "      <td>BBC1</td>\n",
       "      <td>Weather for the Week Ahead: Series 2022</td>\n",
       "      <td>programme</td>\n",
       "      <td>2023-01-01 03:14:33</td>\n",
       "      <td>3</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>0</td>\n",
       "      <td>01/01/2023</td>\n",
       "      <td>Weather</td>\n",
       "      <td>Adults, Lightest Sixth</td>\n",
       "      <td>0</td>\n",
       "      <td>85800</td>\n",
       "      <td>2023-01-01</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>24837</th>\n",
       "      <td>BBC Network</td>\n",
       "      <td>BBC1</td>\n",
       "      <td>Weather for the Week Ahead: Series 2022</td>\n",
       "      <td>programme</td>\n",
       "      <td>2023-01-01 03:14:33</td>\n",
       "      <td>3</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>0</td>\n",
       "      <td>01/01/2023</td>\n",
       "      <td>Weather</td>\n",
       "      <td>ABC1 Adults, Lightest Third</td>\n",
       "      <td>0</td>\n",
       "      <td>97120</td>\n",
       "      <td>2023-01-01</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>24838</th>\n",
       "      <td>BBC Network</td>\n",
       "      <td>BBC1</td>\n",
       "      <td>Weather for the Week Ahead: Series 2022</td>\n",
       "      <td>programme</td>\n",
       "      <td>2023-01-01 03:14:33</td>\n",
       "      <td>3</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>0</td>\n",
       "      <td>01/01/2023</td>\n",
       "      <td>Weather</td>\n",
       "      <td>Adults 16-34, Lightest Third</td>\n",
       "      <td>0</td>\n",
       "      <td>47380</td>\n",
       "      <td>2023-01-01</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>24839</th>\n",
       "      <td>BBC Network</td>\n",
       "      <td>BBC1</td>\n",
       "      <td>Weather for the Week Ahead: Series 2022</td>\n",
       "      <td>programme</td>\n",
       "      <td>2023-01-01 03:14:33</td>\n",
       "      <td>3</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>False</td>\n",
       "      <td>True</td>\n",
       "      <td>0</td>\n",
       "      <td>01/01/2023</td>\n",
       "      <td>Weather</td>\n",
       "      <td>Boys 10-12</td>\n",
       "      <td>0</td>\n",
       "      <td>12720</td>\n",
       "      <td>2023-01-01</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>24840 rows × 17 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "      panel_region station_name  \\\n",
       "0      BBC Network         BBC1   \n",
       "1      BBC Network         BBC1   \n",
       "2      BBC Network         BBC1   \n",
       "3      BBC Network         BBC1   \n",
       "4      BBC Network         BBC1   \n",
       "...            ...          ...   \n",
       "24835  BBC Network         BBC1   \n",
       "24836  BBC Network         BBC1   \n",
       "24837  BBC Network         BBC1   \n",
       "24838  BBC Network         BBC1   \n",
       "24839  BBC Network         BBC1   \n",
       "\n",
       "                                          programme_name programme_type  \\\n",
       "0      Michael McIntyre's The Wheel: Series 3, Episode 7      programme   \n",
       "1      Michael McIntyre's The Wheel: Series 3, Episode 7      programme   \n",
       "2      Michael McIntyre's The Wheel: Series 3, Episode 7      programme   \n",
       "3      Michael McIntyre's The Wheel: Series 3, Episode 7      programme   \n",
       "4      Michael McIntyre's The Wheel: Series 3, Episode 7      programme   \n",
       "...                                                  ...            ...   \n",
       "24835            Weather for the Week Ahead: Series 2022      programme   \n",
       "24836            Weather for the Week Ahead: Series 2022      programme   \n",
       "24837            Weather for the Week Ahead: Series 2022      programme   \n",
       "24838            Weather for the Week Ahead: Series 2022      programme   \n",
       "24839            Weather for the Week Ahead: Series 2022      programme   \n",
       "\n",
       "      programme_start_datetime  programme_duration_minutes  spans_normal_day  \\\n",
       "0          2022-12-25 18:25:43                          57             False   \n",
       "1          2022-12-25 18:25:43                          57             False   \n",
       "2          2022-12-25 18:25:43                          57             False   \n",
       "3          2022-12-25 18:25:43                          57             False   \n",
       "4          2022-12-25 18:25:43                          57             False   \n",
       "...                        ...                         ...               ...   \n",
       "24835      2023-01-01 03:14:33                           3             False   \n",
       "24836      2023-01-01 03:14:33                           3             False   \n",
       "24837      2023-01-01 03:14:33                           3             False   \n",
       "24838      2023-01-01 03:14:33                           3             False   \n",
       "24839      2023-01-01 03:14:33                           3             False   \n",
       "\n",
       "       uk_premiere  broadcaster_premiere  programme_repeat  episode_number  \\\n",
       "0             True                  True             False               7   \n",
       "1             True                  True             False               7   \n",
       "2             True                  True             False               7   \n",
       "3             True                  True             False               7   \n",
       "4             True                  True             False               7   \n",
       "...            ...                   ...               ...             ...   \n",
       "24835        False                 False              True               0   \n",
       "24836        False                 False              True               0   \n",
       "24837        False                 False              True               0   \n",
       "24838        False                 False              True               0   \n",
       "24839        False                 False              True               0   \n",
       "\n",
       "            episode_name          genre                 audience_name  \\\n",
       "0      Christmas Special  Entertainment                     All Homes   \n",
       "1      Christmas Special  Entertainment                    All Adults   \n",
       "2      Christmas Special  Entertainment                       All Men   \n",
       "3      Christmas Special  Entertainment               All Houseperson   \n",
       "4      Christmas Special  Entertainment        All Children aged 4-15   \n",
       "...                  ...            ...                           ...   \n",
       "24835         01/01/2023        Weather        Adults, Lightest Third   \n",
       "24836         01/01/2023        Weather        Adults, Lightest Sixth   \n",
       "24837         01/01/2023        Weather   ABC1 Adults, Lightest Third   \n",
       "24838         01/01/2023        Weather  Adults 16-34, Lightest Third   \n",
       "24839         01/01/2023        Weather                    Boys 10-12   \n",
       "\n",
       "       audience_size_hundreds  audience_target_size_hundreds  \\\n",
       "0                       28849                         272070   \n",
       "1                       55235                         514750   \n",
       "2                       21919                         250780   \n",
       "3                       31321                         272070   \n",
       "4                        5348                          95890   \n",
       "...                       ...                            ...   \n",
       "24835                       0                         171580   \n",
       "24836                       0                          85800   \n",
       "24837                       0                          97120   \n",
       "24838                       0                          47380   \n",
       "24839                       0                          12720   \n",
       "\n",
       "      date_of_transmission  \n",
       "0               2022-12-25  \n",
       "1               2022-12-25  \n",
       "2               2022-12-25  \n",
       "3               2022-12-25  \n",
       "4               2022-12-25  \n",
       "...                    ...  \n",
       "24835           2023-01-01  \n",
       "24836           2023-01-01  \n",
       "24837           2023-01-01  \n",
       "24838           2023-01-01  \n",
       "24839           2023-01-01  \n",
       "\n",
       "[24840 rows x 17 columns]"
      ]
     },
     "execution_count": 5,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "bbc_1_progs.to_dataframe()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.18"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}