Generate a play-out report for wallpaper adverts

Modified on Thu, 26 Jun, 2025 at 4:29 PM

How to generate a play-out report for wallpaper ads until new signage system is live

Get current mothership pods

kubectl get po -n mother

NAME                                                        READY   STATUS    RESTARTS   AGE

mothership-api-deployment-546cc8dc97-wbskk                  1/1     Running   0          7d2h

mothership-deployment-559558ccb6-frzzk                      1/1     Running   0          4d3h

thisismother-website-backend-deployment-7d4b995c69-49p2k    1/1     Running   0          202d

thisismother-website-frontend-deployment-55bf48b649-7z89m   1/1     Running   0          92d

vendlink-api-deployment-68f7f7b75f-xgpl6                    1/1     Running   0          154d

vendlink-receipt-deployment-74f844dd54-t4zk2                1/1     Running   0          7d2h

Exec bash in current mothership prod pod (Replace with the current pod identifier from step 1)

kubectl exec -it -n mother mothership-deployment-559558ccb6-frzzk -- bash

ALTERNATIVELY if you're sure there's only one current deployment you may do the following:

kubectl exec -it -n mother deployment/mothership-deployment -- bash

Use Artisan signage:plays:get-raw-analytics command to export raw data for certain media ids

php artisan signage:plays:get-raw-analytics --help                                                                                           

Usage:

  signage:plays:get-raw-analytics [options]

Options:
      --start-date[=START-DATE]                    The YYYY-mm-dd date to start from e.g. 2022-02-14
      --end-date[=END-DATE]                        The YYYY-mm-dd date to end at (inclusive) e.g. 2022-02-28
      --wallpaper-media-ids[=WALLPAPER-MEDIA-IDS]  A csv of the media ids to record e.g. 12,15,23,50
  -h, --help                                       Display this help message
  -q, --quiet                                      Do not output any message
  -V, --version                                    Display this application version
      --ansi                                       Force ANSI output
      --no-ansi                                    Disable ANSI output
  -n, --no-interaction                             Do not ask any interactive question
      --env[=ENV]                                  The environment the command should run under
  -v|vv|vvv, --verbose                             Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  Gets the raw wallpaper analytics data by wallpaper media ids.

Specify parameters specific to the request

A typical request will look like the following:

"Ben Alderson - 2 hours ago

can I please get a play out report for:

Campaign Name: Wickes - Chelmsford

10 seconds every minute

04/08/23 – 18/08/23

1 x Screen - Virgin Active Chelmsford"

You need to get the IDs for the media (not schedule or pattern) that are included in the request. In this case we are interested in the adverts within the pattern specified in the Wickes - Chelmsford 04/08/23 – 18/08/23 schedule

Their IDs can easily be obtained from the URL. I.e. in this case, https://ship.thisismother.com/wallpaper-media/891/edit and https://ship.thisismother.com/wallpaper-media/892/edit

Always include a day before and a day after the request within the export in order to capture all data.

So our final command will look like:

php artisan signage:plays:get-raw-analytics --start-date=2025-05-02 --end-date=2025-05-21 --wallpaper-media-ids=1342,1343,1344,1344,1331,1332,1333,1334

And yield the following output:

13:16:10  Look across 17 day(s).

13:16:11  Found 0 in page 1 for 2023-08-03

13:16:11  Found 0 in page 2 for 2023-08-03

...

13:21:16  Found 44 in page 27 for 2023-08-19

13:21:17  Found 58 in page 28 for 2023-08-19

13:21:17  Found 1,579 out of 1,725,533 analytics across 1 Pod(s) for 2023-08-19

13:21:20  Created file /tmp/raw-analytics/2023-08-19.csv

13:21:20  Added file to zip

13:21:20  Created zip /tmp/raw-analytics.zip

Copy the file from the pod to your local machine and send to the requester

kubectl cp -n mother mothership-deployment-559558ccb6-frzzk:/tmp/raw-analytics.zip ./raw-analytics.zip

You'll need the pod ID obtained previously, and the location of the outputted file. This will save it locally and then you can send the zip to the original requester