Reporting Service

The reporting service is responsible for providing information and reports. Examples include sales reports and promo code usage.

Analytics

Summary: Analytics Report
Authentication: X-Auth Admin
                      GET /services/reporting/analytics/lite?start_date=[start]&end_date=[end]&gAgeRange=[n]&gEvent=[n]&gGender=[n]&gRegion=[n]&gTitle=[n]&item=[title]

Description

Use this API to get an analytics report for the specified period. This report can also include information about the user demographics. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.
gAgeRange Whether the report is broken down by age range. Set to 1 to enable, 0 to disable.
gEvent Whether the report is broken down by event. Set to 1 to enable, 0 to disable.
gGender Whether the report is broken down by gender. Set to 1 to enable, 0 to disable.
gRegion Whether the report is broken down by region. Set to 1 to enable, 0 to disable.
gTitle Whether the report is broken down by title. Set to 1 to enable, 0 to disable.
item Filter the report by a specific title.

Response Parameters

Analytics report formatted as HTML.

Examples

Request Analytics Report for 7-day Period

curl -i 'https://store.shift72.com/services/reporting/analytics/lite?start_date=2020-02-21T00:00:00%2B13:00&end_date=2020-02-27T23:59:59%2B13:00&gAgeRange=0&gEvent=1&gGender=0&gRegion=0&gTitle=1&item=%2Ftv%2F24%2Fseason%2F1' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

<table class="table table-striped">
  <thead>
    <tr>
        <th>Title</th>
      <th>Count</th>
    </tr>
  </thead>
  <tbody>
    <tr>
        <td>The Hunger Games: Catching Fire</td>
      <td>101</td>
    </tr>
    <tr>
        <td>Grabbers</td>
      <td>56</td>
    </tr>
    <tr>
        <td>Aliens</td>
      <td>31</td>
    </tr>
  </tbody>

</table>

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Analytics (CSV)

Summary: Analytics Report with the result as comma separated values
Authentication: X-Auth Admin
                      GET /services/reporting/analytics/lite.csv?start_date=[start]&end_date=[end]&gAgeRange=[n]&gEvent=[n]&gGender=[n]&gRegion=[n]&gTitle=[n]&item=[title]

Description

Use this API to get an analytics report for the specified period. This report can also include information about the user demographics. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.
gAgeRange Whether the report is broken down by age range. Set to 1 to enable, 0 to disable.
gEvent Whether the report is broken down by event. Set to 1 to enable, 0 to disable.
gGender Whether the report is broken down by gender. Set to 1 to enable, 0 to disable.
gRegion Whether the report is broken down by region. Set to 1 to enable, 0 to disable.
gTitle Whether the report is broken down by title. Set to 1 to enable, 0 to disable.
item Filter the report by a specific title.

Response Parameters

Analytics report formatted as CSV.

Examples

Request Analytics Report for 7-day Period with Result as CSV

curl -i 'https://store.shift72.com/services/reporting/analytics/lite.csv?start_date=2020-02-21T00:00:00%2B13:00&end_date=2020-02-27T23:59:59%2B13:00&gAgeRange=0&gEvent=1&gGender=0&gRegion=0&gTitle=1&item=%2Ftv%2F24%2Fseason%2F1' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

HttpStatus: 200
"Title","Count"
"The Hunger Games: Catching Fire","100"
"Grabbers","56"
"Aliens","31"

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Dashboard Expired

Summary: Provide a list of expired content
Authentication: X-Auth Admin
                      GET /services/reporting/dashboard/expired

Description

Use this API to get a list of films and TV seasons that have expired. Expired content is when the content can no longer be viewed by a user. This API is only accessible to users who have the admin role.

Response Parameters

JSON array of slugs of expired content.

Examples

Request Dashboard Expired Content

curl -i 'https://store.shift72.com/services/reporting/dashboard/expired' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

HttpStatus: 200
[  
   "/tv/79/season/1",
   "/tv/51/season/2",
   "/tv/33/season/1",
   "/tv/69/season/9",
   "/tv/53/season/1",
   "/tv/48/season/2"
]

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Dashboard Popular Sales

Summary: Provide summary of the most popular content by sales
Authentication: X-Auth Admin
                      GET /services/reporting/dashboard/popular

Description

Use this API to get summary information of the top six items that have the most sales. This API is only accessible to users who have the admin role.

Response Parameters

JSON array of pairs with the item slug and the number of sales.

Examples

Request Dashboard Rollup

curl -i 'https://store.shift72.com/services/reporting/dashboard/popular' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

HttpStatus: 200
[  
  [  
    "/film/65",
    21
  ],
  [  
    "/film/94",
    12
  ],
  [  
    "/film/71",
    10
  ],
  [  
    "/film/73",
    10
  ],
  [  
    "/film/45",
    10
  ],
  [  
    "/film/93",
    9
  ]
]

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Dashboard Popular Streams

Summary: Provide summary of the most popular content by streams
Authentication: X-Auth Admin
                      GET /services/reporting/v2/telemetry/popular_streams

Description

Use this API to get summary information of the top six items that have the most streams. This API is only accessible to users who have the admin role.

Response Parameters

JSON array of pairs with the item slug and the number of sales.

Examples

Request Dashboard Rollup

curl -i 'https://store.shift72.com/services/reporting/v2/telemetry/popular_streams' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

HttpStatus: 200
[  
  [  
    "/film/65",
    21
  ],
  [  
    "/film/94",
    12
  ],
  [  
    "/film/71",
    10
  ],
  [  
    "/film/73",
    10
  ],
  [  
    "/film/45",
    10
  ],
  [  
    "/film/93",
    9
  ]
]

Response: Unauthorized

HttpStatus: 401
Unauthorized

Response: Invalid Permissions

HttpStatus: 403
Forbidden

Dashboard Recent Streams

Summary: Provide a summary of streams
Authentication: X-Auth Admin
                      GET /services/reporting/v2/telemetry/recent_streams?start_date=[start]&end_date=[end]

Description

Use this API to get summary information of the number of streams that have occurred during the specified period. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

JSON array of pairs with the date and the number of streams for that date.

Examples

Request Dashboard Recent Streams for 7-day period

curl -i 'https://store.shift72.com/services/reporting/v2/telemetry/recent_streams?end_date=2015-06-17T23:59:59%2B12:00&start_date=2015-06-11T00:00:00%2B12:00' \
  -H 'x-auth-token: 1a1f4363bac4df5ba34758945fae8d0d'

Response: Success

HttpStatus: 200
[  
  [  
    "2015-06-11",
    576
  ],
  [  
    "2015-06-12",
    543
  ],
  [  
    "2015-06-13",
    727
  ],
  [  
    "2015-06-14",
    612
  ],
  [  
    "2015-06-15",
    539
  ],
  [  
    "2015-06-16",
    759
  ],
  [  
    "2015-06-17",
    688
  ]
]

Response: Unauthorized

HttpStatus: 401
Unauthorized

Response: Invalid Permissions

HttpStatus: 403
Forbidden

Dashboard Rollup

Summary: Provide summary information
Authentication: X-Auth Admin
                      GET /services/reporting/v2/telemetry/rollup

Description

Use this API to get summary information. This API is only accessible to users who have the admin role.

Response Parameters

Parameter Type Description
users_count number The number of registered users minus users that are suspended.
films_count number The number of published films.
seasons_count number The number of published TV seasons.
sales_count number The number of sales that have been made minus any refunds.
plays_count number Deprecated. This number is inaccurate and should not be used.

Examples

Request Dashboard Rollup

curl -i 'https://store.shift72.com/services/reporting/v2/telemetry/rollup' \
  -H 'x-auth-token: 1a1f4363bac4df5ba34758945fae8d0d'

Response: Success

HttpStatus: 200
{  
  "users_count":80,
  "films_count":29,
  "seasons_count":3,
  "sales_count":157,
  "plays_count":428
}

Response: Unauthorized

HttpStatus: 401
Unauthorized

Response: Invalid Permissions

HttpStatus: 403
Forbidden

Dashboard Sales

Summary: Provide a summary of sales
Authentication: X-Auth Admin
                      GET /services/reporting/dashboard/sales?start_date=[start]&end_date=[end]

Description

Use this API to get summary information about the number of sales that have been made during the specified period. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

JSON array of pairs with the date and the number of sales for that date.

Examples

Request Dashboard Sales for 7-day Period

curl -i 'https://store.shift72.com/services/reporting/dashboard/sales?end_date=2015-06-17T23:59:59%2B12:00&start_date=2015-06-11T00:00:00%2B12:00' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

HttpStatus: 200
[  
  [  
    "2015-06-05",
    0
  ],
  [  
    "2015-06-06",
    0
  ],
  [  
    "2015-06-07",
    0
  ],
  [  
    "2015-06-08",
    0
  ],
  [  
    "2015-06-09",
    0
  ],
  [  
    "2015-06-10",
    0
  ],
  [  
    "2015-06-11",
    0
  ]
]

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Dashboard Signups

Summary: Provide a summary of signups
Authentication: X-Auth Admin
                      GET /services/reporting/dashboard/signups?start_date=[start]&end_date=[end]

Description

Use this API to get summary information of the number of users that have created accounts during the specified period. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

JSON array of pairs with the date and the number of signups for that date.

Examples

Request Dashboard Signups for 7-day period

curl -i 'https://store.shift72.com/services/reporting/dashboard/signups?end_date=2015-06-17T23:59:59%2B12:00&start_date=2015-06-11T00:00:00%2B12:00' \
  -H 'x-auth-token: 1a1f4363bac4df5ba34758945fae8d0d'

Response: Success

HttpStatus: 200
[  
  [  
    "2015-06-11",
    0
  ],
  [  
    "2015-06-12",
    0
  ],
  [  
    "2015-06-13",
    0
  ],
  [  
    "2015-06-14",
    0
  ],
  [  
    "2015-06-15",
    1
  ],
  [  
    "2015-06-16",
    1
  ],
  [  
    "2015-06-17",
    2
  ]
]

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Items

Summary: Items Report
Authentication: X-Auth Admin
                      GET /services/reporting/items/lite?start_date=[start]&end_date=[end]

Description

Use this API to get an items report for the specified period. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

Items report formatted as HTML.

Examples

Request Items Report for 7-day period

curl -i 'https://store.shift72.com/services/reporting/items/lite?end_date=2015-06-17T11:59:59.999Z&start_date=2015-06-10T12:00:00.000Z' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

<table class="table">
  <thead>
    <tr>
      <th>Pricing Region</th>
      <th>Rent Sales</th>
      <th>Rent Refunds</th>
      <th class="text-right">Rent Earnings</th>
      <th>Rent Refunds Amount</th>
      <th>Buy Sales</th>
      <th>Buy Refunds</th>
      <th class="text-right">Buy Earnings</th>
      <th>Buy Refunds Amount</th>
      <th>Total Sales</th>
      <th>Total Refunds</th>
      <th class="text-right">Total Earnings</th>
      <th class="text-right">Total Refund Amount</th>
      <th class="text-right">Total Amount</th>
    </tr>
  </thead>
  <tbody>
      <tr>
        <td colspan="14">
          <h5>
            <strong>Design and Thinking</strong>
          </h5>
        </td>
      </tr>
        <tr>
          <td>America</td>
          <td>0</td>
          <td>0</td>
          <td class="text-right">
            $0.00 USD
          </td>
          <td class="text-right">
            $0.00 USD
          </td>
          <td>2</td>
          <td>0</td>
          <td class="text-right">
            $29.98 USD
          </td>
          <td class="text-right">
            $0.00 USD
          </td>
          <td>2</td>
          <td>0</td>
          <td class="text-right">
            $29.98 USD
          </td>
          <td class="text-right">
            $0.00 USD
          </td>
          <td class="text-right">
            $29.98 USD
          </td>
        </tr>
      <tr>
        <td colspan="14">
          <h5>
            <strong>The Brokenwood Mysteries Season 1</strong>
          </h5>
        </td>
      </tr>
        <tr>
          <td>New Zealand</td>
          <td>0</td>
          <td>0</td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td>1</td>
          <td>0</td>
          <td class="text-right">
            $24.99 NZD
          </td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td>1</td>
          <td>0</td>
          <td class="text-right">
            $24.99 NZD
          </td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td class="text-right">
            $24.99 NZD
          </td>
        </tr>
      <tr>
        <td colspan="14">
          <h5>
            <strong>Undercover</strong>
          </h5>
        </td>
      </tr>
        <tr>
          <td>New Zealand</td>
          <td>0</td>
          <td>0</td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td>1</td>
          <td>1</td>
          <td class="text-right">
            $6.49 NZD
          </td>
          <td class="text-right">
            $6.49 NZD
          </td>
          <td>1</td>
          <td>1</td>
          <td class="text-right">
            $6.49 NZD
          </td>
          <td class="text-right">
            $6.49 NZD
          </td>
          <td class="text-right">
            $0.00 NZD
          </td>
        </tr>
      <tr>
        <td colspan="14">
          <h5>
            <strong>Saints and Soldiers</strong>
          </h5>
        </td>
      </tr>
        <tr>
          <td>New Zealand</td>
          <td>1</td>
          <td>1</td>
          <td class="text-right">
            $5.45 NZD
          </td>
          <td class="text-right">
            $5.45 NZD
          </td>
          <td>0</td>
          <td>0</td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td>1</td>
          <td>1</td>
          <td class="text-right">
            $5.45 NZD
          </td>
          <td class="text-right">
            $5.45 NZD
          </td>
          <td class="text-right">
            $0.00 NZD
          </td>
        </tr>
      <tr>
        <td colspan="14">
          <h5>
            <strong>The Silk</strong>
          </h5>
        </td>
      </tr>
        <tr>
          <td>New Zealand</td>
          <td>1</td>
          <td>0</td>
          <td class="text-right">
            $2.99 NZD
          </td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td>0</td>
          <td>0</td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td>1</td>
          <td>0</td>
          <td class="text-right">
            $2.99 NZD
          </td>
          <td class="text-right">
            $0.00 NZD
          </td>
          <td class="text-right">
            $2.99 NZD
          </td>
        </tr>
  </tbody>
</table>

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Items (CSV)

Summary: Items Report with the result as comma separated values
Authentication: X-Auth Admin
                      GET /services/reporting/items/lite.csv?start_date=[start]&end_date=[end]

Description

Use this API to get an items report for the specified period with the result as comma separated values (CSV). This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

Items report formatted as CSV.

Examples

Request Items Report for 7-day period with Result as CSV

curl -i 'https://store.shift72.com/services/reporting/items/lite.csv?end_date=2015-06-17T11:59:59.999Z&start_date=2015-06-10T12:00:00.000Z' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

HttpStatus: 200
"Item","Pricing Region","Rent Sales","Rent Refunds","Rent Earnings","Rent Refunds Amount","Buy Sales","Buy Refunds","Buy Earnings","Buy Refunds Amount","Total Sales","Total Refunds","Total Earnings","Total Refund Amount","Total Amount","Currency"
"Design and Thinking","America","0","0","0","0","2","0","29.98","0.0","2","0","29.98","0.0","29.98","USD"
"The Brokenwood Mysteries Season 1","New Zealand","0","0","0","0","1","0","24.99","0.0","1","0","24.99","0.0","24.99","NZD"
"Undercover","New Zealand","0","0","0","0","1","1","6.49","6.49","1","1","6.49","6.49","0.0","NZD"
"Saints and Soldiers","New Zealand","1","1","5.45","5.45","0","0","0","0","1","1","5.45","5.45","0.0","NZD"
"The Silk","New Zealand","1","0","2.99","0.0","0","0","0","0","1","0","2.99","0.0","2.99","NZD"

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Orders

Summary: Orders Report
Authentication: X-Auth Admin
                      GET /services/reporting/orders/lite?start_date=[start]&end_date=[end]

Description

Use this API to get an orders report for the specified period. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

Orders report formatted as HTML.

Examples

Request Orders Report for 7-day period

curl -i 'https://store.shift72.com/services/reporting/orders/lite?end_date=2015-06-17T11:59:59.999Z&start_date=2015-06-10T12:00:00.000Z' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

<table class="table table-striped">
  <thead>
    <tr>
      <th>Invoice Number</th>
      <th>Date</th>
      <th>Title</th>
      <th>Name</th>
      <th>Email</th>
      <th>Ownership</th>
      <!--
      <th>Quality</th>
      -->
      <th class="text-right">Original Price</th>
      <th class="text-right">Discount Amount</th>
      <th class="text-right">Total Price</th>
      <th>Pricing Region</th>
      <th>Country</th>
      <th>Ip Address</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>3238</td>
      <td>Jun 17, 2015 02:15 AM UTC</td>
      <td>The Brokenwood Mysteries Season 1</td>
      <td>Joe</td>
      <td>user@example.com</td>
      <td>Buy</td>
      <!--
      <td>HD</td>
      -->
      <td class="text-right">
        $24.99
        NZD
      </td>
      <td class="text-right">
        $0.00
        NZD
      </td>
      <td class="text-right">
        $24.99
        NZD
      </td>
      <td>New Zealand</td>
      <td>New Zealand</td>
      <td>8.8.8.8</td>
    </tr>
    <tr>
      <td>3234</td>
      <td>Jun 16, 2015 09:01 PM UTC</td>
      <td>Design and Thinking</td>
      <td>David</td>
      <td>usa@example.com</td>
      <td>Buy</td>
      <!--
      <td>HD</td>
      -->
      <td class="text-right">
        $14.99
        USD
      </td>
      <td class="text-right">
        $0.00
        USD
      </td>
      <td class="text-right">
        $14.99
        USD
      </td>
      <td>America</td>
      <td>United States</td>
      <td>1.2.3.4</td>
    </tr>
    <tr>
      <td>3228</td>
      <td>Jun 15, 2015 09:50 PM UTC</td>
      <td>Design and Thinking</td>
      <td>David</td>
      <td>usa@example.com</td>
      <td>Buy</td>
      <!--
      <td>HD</td>
      -->
      <td class="text-right">
        $14.99
        USD
      </td>
      <td class="text-right">
        $0.00
        USD
      </td>
      <td class="text-right">
        $14.99
        USD
      </td>
      <td>America</td>
      <td>United States</td>
      <td>1.2.3.4</td>
    </tr>
    <tr>
      <td>3222</td>
      <td>Jun 14, 2015 11:09 PM UTC</td>
      <td>The Silk</td>
      <td>Louis8</td>
      <td>me@example.com</td>
      <td>Rent</td>
      <!--
      <td>HD</td>
      -->
      <td class="text-right">
        $2.99
        NZD
      </td>
      <td class="text-right">
        $0.00
        NZD
      </td>
      <td class="text-right">
        $2.99
        NZD
      </td>
      <td>New Zealand</td>
      <td>New Zealand</td>
      <td>8.8.8.8</td>
    </tr>
    <tr>
      <td>3221</td>
      <td>Jun 14, 2015 10:50 PM UTC</td>
      <td>Undercover</td>
      <td>Louis8</td>
      <td>me@example.com</td>
      <td>Buy</td>
      <!--
      <td>HD</td>
      -->
      <td class="text-right">
        $12.99
        NZD
      </td>
      <td class="text-right">
        $6.50
        NZD
      </td>
      <td class="text-right">
        $6.49
        NZD
      </td>
      <td>New Zealand</td>
      <td>New Zealand</td>
      <td>8.8.8.8</td>
    </tr>
    <tr>
      <td>3211</td>
      <td>Jun 12, 2015 02:18 AM UTC</td>
      <td>Saints and Soldiers</td>
      <td>Louis8</td>
      <td>me@example.com</td>
      <td>Rent</td>
      <!--
      <td>HD</td>
      -->
      <td class="text-right">
        $6.99
        NZD
      </td>
      <td class="text-right">
        $1.54
        NZD
      </td>
      <td class="text-right">
        $5.45
        NZD
      </td>
      <td>New Zealand</td>
      <td>New Zealand</td>
      <td>8.8.8.8</td>
    </tr>
  </tbody>

</table>

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Orders (CSV)

Summary: Orders Report with the result as comma separated values
Authentication: X-Auth Admin
                      GET /services/reporting/orders/lite.csv?start_date=[start]&end_date=[end]

Description

Use this API to get an orders report for the specified period with the result as comma separated values (CSV). This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

Orders report formatted as CSV.

Examples

Orders Items Report for 7-day period with Result as CSV

curl -i 'https://store.shift72.com/services/reporting/orders/lite.csv?end_date=2015-06-17T11:59:59.999Z&start_date=2015-06-10T12:00:00.000Z' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

HttpStatus: 200
"Invoice Number","Date","Title","Name","Email","Ownership","Original Price","Discount Amount","Total Price","Currency","Pricing Region","Country","Ip Address"
"3238","17-06-15  2:15 AM","The Brokenwood Mysteries Season 1","Joe","user@example.com","buy","24.99","0.0","24.99","NZD","New Zealand","New Zealand","8.8.8.8"
"3234","16-06-15  9:01 PM","Design and Thinking","David","usa@example.com","buy","14.99","0.0","14.99","USD","America","United States","1.2.3.4"
"3228","15-06-15  9:50 PM","Design and Thinking","David","usa@example.com","buy","14.99","0.0","14.99","USD","America","United States","1.2.3.4"
"3222","14-06-15 11:09 PM","The Silk","Louis8","me@example.com","rent","2.99","0.0","2.99","NZD","New Zealand","New Zealand","8.8.8.8"
"3221","14-06-15 10:50 PM","Undercover","Louis8","me@example.com","buy","12.99","6.5","6.49","NZD","New Zealand","New Zealand","8.8.8.8"
"3211","12-06-15  2:18 AM","Saints and Soldiers","Louis8","me@example.com","rent","6.99","1.54","5.45","NZD","New Zealand","New Zealand","8.8.8.8"

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Promo Code Usage

Summary: Promo Code Usage Report
Authentication: X-Auth Admin
                      GET /services/reporting/discount_usages/lite?discount_id=[id]&start_date=[start]&end_date=[end]

Description

Use this API to get a promo code usage report for the specified period. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
discount_id The ID of a specific promo code.
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

Promo code usage report formatted as HTML.

Examples

Request Promo Code Usage Report for 7-day period for Promo Code 15

curl -i  'https://store.shift72.com/services/reporting/discount_usages/lite?discount_id=15&end_date=2015-06-17T11:59:59.999Z&page=&start_date=2015-06-10T12:00:00.000Z' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

<table class="table table-striped">
  <thead>
    <tr>
      <th>Invoice Number</th>
      <th>Date</th>
      <th>Title</th>
      <th>Name</th>
      <th>Email</th>
      <th>Ownership</th>
      <!--
      <th>Quality</th>
      -->
      <th class="text-right">Original Price</th>
      <th class="text-right">Discount Amount</th>
      <th class="text-right">Total Price</th>
      <th>Pricing Region</th>
      <th>Country</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>3221</td>
      <td>Jun 14, 2015 10:50 PM UTC</td>
      <td>Undercover</td>
      <td>Louis8</td>
      <td>me@example.com</td>
      <td>Buy</td>
      <!--
      <td>HD</td>
      -->
      <td class="text-right">
        $12.99
        NZD
      </td>
      <td class="text-right">
        $6.50
        NZD
      </td>
      <td class="text-right">
        $6.49
        NZD
      </td>
      <td>New Zealand</td>
      <td>New Zealand</td>
    </tr>
  </tbody>
</table>

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Promo Code Usage (CSV)

Summary: Promo Code Usage Report with the result as comma separated values
Authentication: X-Auth Admin
                      GET /services/reporting/discount_usages/lite.csv?discount_id=[id]&start_date=[start]&end_date=[end]

Description

Use this API to get a promo code usage report for the specified period with the result as comma separated values (CSV). This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
discount_id The ID of a specific promo code.
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

Promo code usage report formatted as CSV.

Examples

Request Promo Code Usage Report for 7-day period for Promo Code 15 with Result as CSV

curl -i  'https://store.shift72.com/services/reporting/discount_usages/lite.csv?discount_id=15&end_date=2015-06-17T11:59:59.999Z&page=&start_date=2015-06-10T12:00:00.000Z' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

HttpStatus: 200
"Invoice Number","Date","Title","Name","Email","Ownership","Original Price","Discount Amount","Total Price","Currency","Pricing Region","Country"
"3221","14-06-15 10:50 PM","Undercover","Louis8","me@example.com","buy","12.99","6.5","6.49","NZD","New Zealand","New Zealand"

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Refunds

Summary: Refunds Report
Authentication: X-Auth Admin
                      GET /services/reporting/refunds/lite?start_date=[start]&end_date=[end]

Description

Use this API to get a refunds report for the specified period. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

Refund report formatted as HTML.

Examples

Request Refund Report for 7-day period

curl -i 'https://store.shift72.com/services/reporting/refunds/lite?end_date=2015-06-17T11:59:59.999Z&start_date=2015-06-10T12:00:00.000Z' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

<table class="table table-striped">
  <thead>
    <tr>
      <th>Invoice Number</th>
      <th>Refund Date</th>
      <th>Purchase Date</th>
      <th>Title</th>
      <th>User Name</th>
      <th>Ownership</th>
      <th class="text-right">Amount</th>
      <th>Reason</th>
      <th>CC Refund Status</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>3221</td>
      <td>Jun 14, 2015 11:47 PM UTC</td>
      <td>Jun 14, 2015 10:50 PM UTC</td>
      <td>Undercover</td>
      <td>Louis8</td>
      <td>Buy</td>
      <td class="text-right">
        $6.49
        NZD
      </td>
      <td>issue discount refund 6.49</td>
      <td>Completed</td>
    </tr>
    <tr>
      <td>3211</td>
      <td>Jun 12, 2015 02:19 AM UTC</td>
      <td>Jun 12, 2015 02:18 AM UTC</td>
      <td>Saints and Soldiers</td>
      <td>Louis8</td>
      <td>Rent</td>
      <td class="text-right">
        $5.45
        NZD
      </td>
      <td>issue discount purchase 5.45</td>
      <td>Completed</td>
    </tr>
  </tbody>

</table>

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Refunds (CSV)

Summary: Refunds Report with the result as comma separated values
Authentication: X-Auth Admin
                      GET /services/reporting/refunds/lite.csv?start_date=[start]&end_date=[end]

Description

Use this API to get a refunds report for the specified period with the result as comma separated values (CSV). This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

Refunds report formatted as CSV.

Examples

Refunds Items Report for 7-day period with Result as CSV

curl -i 'https://store.shift72.com/services/reporting/refunds/lite.csv?end_date=2015-06-17T11:59:59.999Z&start_date=2015-06-10T12:00:00.000Z' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

HttpStatus: 200
"Invoice Number","Refund Date","Purchase Date","Title","User Name","Email","Ownership","Amount","Currency","Pricing Region","Country","Reason","CC Refund Status"
"3221","14-06-15 11:47 PM","14-06-15 10:50 PM","Undercover","Louis8","me@example.com","buy","6.49","NZD","New Zealand","New Zealand","issue discount refund 6.49","Completed"
"3211","12-06-15  2:19 AM","12-06-15  2:18 AM","Saints and Soldiers","Louis8","me@example.com","rent","5.45","NZD","New Zealand","New Zealand","issue discount purchase 5.45","Completed"

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Streams

Summary: Streams Report
Authentication: X-Auth Admin
                      GET /services/reporting/v2/telemetry/streams.json?start_date=[start]&end_date=[end]&gAgeRange=[n]&gGender=[n]&gPricingRegion=[n]&gTitle=[n]&item=[title]

Description

Use this API to get a streams report for the specified period. This report can also include information about the user demographics. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The RFC3339 start time and date preferably with the a timezone or it will default to UTC.
end_date The RFC3339 end time and date preferably with the a timezone or it will default to UTC.
gAgeRange Whether the report is broken down by age range. Set to 1 to enable, 0 to disable.
gGender Whether the report is broken down by gender. Set to 1 to enable, 0 to disable.
gPricingRegion Whether the report is broken down by pricing region. Set to 1 to enable, 0 to disable.
gTitle Filter the report by a specific title.

Response Parameters

Streams report formatted as JSON by default.

Examples

Request Streams Report for 7-day period

curl -i 'https://store.shift72.com/services/reporting/v2/telemetry/streams.json?end_date=2015-12-20T10:59:59.999Z&gAgeRange=0&gGender=0&gPricingRegion=0&gTitle=1&item=&start_date=2015-12-13T11:00:00.000Z' \
  -H 'x-auth-token: your-auth-token'

Response: Success

[
  {
    "slug": "/film/1",
    "title": "Hunger Games",
    "plans": "None",
    "count": 1
  },
  {
    "slug": "/film/1/bonus/1",
    "title": "Hunger Games - bonus footage",
    "plans": "None",
    "count": 1
  },
  {
    "slug": "/tv/1/season/1/episode/1",
    "title": "Mr Robot - Season 1, Episode 1",
    "plans": "None",
    "count": 1
  }
]

Response: Unauthorized

Unauthorized

Streams (CSV)

Summary: Streams Report with the result as comma separated values
Authentication: X-Auth Admin
                      GET /services/reporting/v2/telemetry/streams.csv?start_date=[start]&end_date=[end]&gAgeRange=[n]&gGender=[n]&gPricingRegion=[n]&gTitle=[n]&item=[title]

Description

Use this API to get a streams report for the specified period. This report can also include information about the user demographics. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.
gAgeRange Whether the report is broken down by age range. Set to 1 to enable, 0 to disable.
gGender Whether the report is broken down by gender. Set to 1 to enable, 0 to disable.
gPricingRegion Whether the report is broken down by pricing region. Set to 1 to enable, 0 to disable.
gTitle Filter the report by a specific title.

Response Parameters

Streams report formatted as CSV.

Examples

Request Streams Report for 7-day period with Result as CSV

curl -i 'https://store.shift72.com/services/reporting/v2/telemetry/streams.csv?end_date=2015-12-20T10:59:59.999Z&gAgeRange=0&gGender=0&gPricingRegion=0&gTitle=1&item=&start_date=2015-12-13T11:00:00.000Z' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

HttpStatus: 200
"Title","Count"
"Design & Thinking","1"
"Mr. Robot - Season 1 - Episode 1","9"
"The Hunger Games - Bonus 3","1"

Response: Unauthorized

HttpStatus: 401
Unauthorized

Response: Invalid Permissions

HttpStatus: 403
Forbidden

Summary

Summary: Summary Report
Authentication: X-Auth Admin
                      GET /services/reporting/summary/lite?start_date=[start]&end_date=[end]

Description

Use this API to get a summary report for the specified period. This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

Summary report formatted as HTML.

Examples

Request Summary Report for 7-day period

curl -i 'https://store.shift72.com/services/reporting/summary/lite?end_date=2015-06-17T11:59:59.999Z&start_date=2015-06-10T12:00:00.000Z' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

<table class="table table-striped">
  <thead>
    <tr>
      <th>Pricing Region</th>
      <th>Rent Sales</th>
      <th>Buy Sales</th>
      <th>Total Sales</th>
      <th>Rent Refunds</th>
      <th>Buy Refunds</th>
      <th>Total Refunds</th>
      <th class="text-right">Rent Earnings</th>
      <th class="text-right">Buy Earnings</th>
      <th class="text-right">Total Earnings</th>
      <th class="text-right">Rent Refund Amount</th>
      <th class="text-right">Buy Refund Amount</th>
      <th class="text-right">Total Refund Amount</th>
      <th class="text-right">Total Amount</th>
    </tr>
  </thead>
  <tbody>
      <tr>
        <td>America</td>
        <td>0</td>
        <td>2</td>
        <td>2</td>
        <td>0</td>
        <td>0</td>
        <td>0</td>
        <td class="text-right">
          $0.00 USD
        </td>
        <td class="text-right">
          $29.98 USD
        </td>
        <td class="text-right">
          $29.98 USD
        </td>
        <td class="text-right">
          $0.00 USD
        </td>
        <td class="text-right">
          $0.00 USD
        </td>
        <td class="text-right">
          $0.00 USD
        </td>
        <td class="text-right">
          $29.98 USD
        </td>
      </tr>
      <tr>
        <td>New Zealand</td>
        <td>2</td>
        <td>2</td>
        <td>4</td>
        <td>1</td>
        <td>1</td>
        <td>2</td>
        <td class="text-right">
          $8.44 NZD
        </td>
        <td class="text-right">
          $31.48 NZD
        </td>
        <td class="text-right">
          $39.92 NZD
        </td>
        <td class="text-right">
          $5.45 NZD
        </td>
        <td class="text-right">
          $6.49 NZD
        </td>
        <td class="text-right">
          $11.94 NZD
        </td>
        <td class="text-right">
          $27.98 NZD
        </td>
      </tr>
  </tbody>
</table>

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>

Summary (CSV)

Summary: Summary Report with the result as comma separated values
Authentication: X-Auth Admin
                      GET /services/reporting/summary/lite.csv?start_date=[start]&end_date=[end]

Description

Use this API to get a summary report for the specified period with the result as comma separated values (CSV). This API is only accessible to users who have the admin role.

Query String Request Parameters

Parameter Description
start_date The ISO 8601 start time and date preferably with the a timezone or it will default to UTC.
end_date The ISO 8601 end time and date preferably with the a timezone or it will default to UTC.

Response Parameters

Summary report formatted as CSV.

Examples

Request Summary Report for 7-day period with Result as CSV

curl -i 'https://store.shift72.com/services/reporting/summary/lite.csv?end_date=2015-06-17T11:59:59.999Z&start_date=2015-06-10T12:00:00.000Z' \
  -H 'x-auth-token: a7499b7029d80791ff18834fec73aeef'

Response: Success

HttpStatus: 200
"Pricing Region","Rent Sales","Buy Sales","Total Sales","Rent Refunds","Buy Refunds","Total Refunds","Rent Earnings","Buy Earnings","Total Earnings","Rent Refund Amount","Buy Refund Amount","Total Refund Amount","Total Amount","Currency"
"America","0","2","2","0","0","0","0","29.98","29.98","0","0.0","0.0","29.98","USD"
"New Zealand","2","2","4","1","1","2","8.44","31.48","39.92","5.45","6.49","11.94","27.98","NZD"

Response: Unauthorized

<html>
  <body>
    You are being <a href="http://store.shift72.com/admin_users/sign_in">redirected</a>.
  </body>
</html>