Reporting API Documentation

#!/usr/bin/env php
<?php

/**
 * Authenticate on the API in order to get an access token
 */
function get_access_token($app_key, $app_secret, $username, $password) {
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, 'https://graphql.api.dailymotion.com/oauth/token');
    $headers = [
        'Content-Type: application/x-www-form-urlencoded'
    ];
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
        'client_id' => $app_key,
        'client_secret' => $app_secret,
        'username' => $username,
        'password' => $password,
        'grant_type' => 'password',
        'version' => '2'
    ]));
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($ch);
    curl_close($ch);

    $tokens = json_decode($response, true);
    if (false === $tokens) {
        throw new \Exception('Invalid authentication response');
    }
    return $tokens['access_token'];
}

/**
 * Creating a report request
 */
function create_report_request($access_token, array $dimensions, array $metrics, $start_date, $end_date, array $filters = []) {
    $report_request = [
        'query' => '
            mutation ($input: AskPartnerReportFileInput!) {
                askPartnerReportFile(input: $input) {
                    reportFile {
                        reportToken
                    }
                }
            }',
        'variables' => [
            'input' => [
                'metrics' => $metrics,
                'dimensions' => $dimensions,
                'filters' => $filters,
                'startDate' => $start_date,
                'endDate' => $end_date
            ]
        ]
    ];

    $report_request = json_encode($report_request);

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, 'https://graphql.api.dailymotion.com');
    $headers = [
        'Authorization: Bearer '.$access_token,
        'Content-Type: application/json',
        'Content-Length: ' . strlen($report_request)
    ];
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $report_request);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($ch);
    curl_close($ch);

    $report_info = json_decode($response, true);
    if (false === $report_info) {
        throw new \Exception('Invalid response');
    }
    return $report_info['data']['askPartnerReportFile']['reportFile']['reportToken'];
}

/**
 * Checking the status of the reporting request
 */
function check_report_status($access_token, $report_token) {
    $report_check_request = [
        'query' => '
            query PartnerGetReportFile ($reportToken: String!) {
                partner {
                    reportFile(reportToken: $reportToken) {
                        status
                        downloadLinks {
                            edges {
                                node {
                                    link
                                }
                            }
                        }
                    }
                }
            }
        ',
        'variables' => [
            'reportToken' => $report_token
        ]
    ];

    $report_check_request = json_encode($report_check_request);

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, 'https://graphql.api.dailymotion.com');
    $headers = [
        'Authorization: Bearer '.$access_token,
        'Content-Type: application/json',
        'Content-Length: ' . strlen($report_check_request)
    ];
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $report_check_request);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($ch);
    curl_close($ch);

    $report_info = json_decode($response, true);
    if (false === $report_info) {
        throw new \Exception('Invalid response');
    }
    $report_status = $report_info['data']['partner']['reportFile']['status'];

    if ($report_status === 'FINISHED') {
        $download_links = [];
        foreach ($report_info['data']['partner']['reportFile']['downloadLinks']['edges'] as $edge) {
            $download_links[] = $edge['node']['link'];
        }

        return $download_links;
    } else {
        return null;
    }
}

/**
 * Downloading the report files
 */
function download_report($download_links, $base_path = null) {
    $cpt = 1;
    if (null === $base_path) {
        $base_path = getcwd();
    }
    foreach ($download_links as $url) {
        $file_path = sprintf("%s/report_%s.csv", $base_path, $cpt);
        file_put_contents($file_path, fopen($url, 'r'));
        echo  sprintf("Raport file %s downloaded: %s\n", $cpt, $file_path);
        $cpt += 1;
    }
}


$app_key = '<your_api_key>';
$app_secret = '<your_api_secret>';
$username = '<your_username>';
$password = '<your_password>';

echo  "Generating access token...\n";
$access_token = get_access_token($app_key, $app_secret, $username, $password);

$dimensions = ['DAY', 'VIDEO_TITLE'];
$metrics = ['VIEWS'];
$filters = [
    'videoOwnerChannelSlug' => '<your_channel_slug>'
];
$start_date = '2018-07-01';
$end_date = '2018-07-04';
echo  "Creating report request...\n";
$report_token = create_report_request($access_token, $dimensions, $metrics, $start_date, $end_date, $filters);

$download_links = null;
while (!$download_links) {
    echo  "Checking report status...\n";
    // Checks every 15secs the report status
    sleep(15);
    $download_links = check_report_status($access_token, $report_token);
}

download_report($download_links);

#!/usr/bin/env python
import requests
import os
import time

def get_access_token(app_key, app_secret, username, password):
    '''
    Authenticate on the API in order to get an access token
    '''
    response = requests.post('https://graphql.api.dailymotion.com/oauth/token', data={
        'client_id': app_key,
        'client_secret': app_secret,
        'username': username,
        'password': password,
        'grant_type': 'password',
        'version': '2'
    })

    if response.status_code != 200 or not 'access_token' in response.json():
        raise Exception('Invalid authentication response')

    return response.json()['access_token']

def create_report_request(access_token, dimensions, metrics, start_date, end_date, filters = None):
    '''
    Creating a report request
    '''
    reportRequest = """
    mutation ($input: AskPartnerReportFileInput!) {
        askPartnerReportFile(input: $input) {
            reportFile {
                reportToken
            }
        }
    }
    """
    response = requests.post(
        'https://graphql.api.dailymotion.com',
        json={
            'query': reportRequest,
            'variables': {
                'input': {
                    'metrics': metrics,
                    'dimensions': dimensions,
                    'filters': filters,
                    'startDate': start_date,
                    'endDate': end_date,
                }
            }
        },
        headers={'Authorization': 'Bearer ' + access_token}
    )

    if response.status_code != 200 or not 'data' in response.json():
        raise Exception('Invalid response')

    return response.json()['data']['askPartnerReportFile']['reportFile']['reportToken'];

def check_report_status(access_token, report_token):
    '''
    Checking the status of the reporting request
    '''
    report_request_status_check = """
    query PartnerGetReportFile ($reportToken: String!) {
        partner {
            reportFile(reportToken: $reportToken) {
                status
                downloadLinks {
                    edges {
                        node {
                            link
                        }
                    }
                }
            }
        }
    }
    """
    response = requests.post(
        'https://graphql.api.dailymotion.com',
        json={
            'query': report_request_status_check,
            'variables': {
                'reportToken': report_token
            }
        },
        headers={'Authorization': 'Bearer ' + access_token}
    )

    if response.status_code != 200 or not 'data' in response.json():
        raise Exception('Invalid response')

    status = response.json()['data']['partner']['reportFile']['status'];

    if (status == 'FINISHED'):
        download_links = []
        for url in map(lambda edge: edge['node']['link'], response.json()['data']['partner']['reportFile']['downloadLinks']['edges']):
            download_links.append(url)
        return download_links
    else:
        return None

def download_report(download_links, base_path=None):
    '''
    Downloading the report files
    '''
    cpt = 1
    if not base_path:
        base_path = os.getcwd()

    for url in download_links:
        r = requests.get(url)
        filename = 'report_{}.csv'.format(cpt)
        file_path = os.path.join(base_path, filename)
        open(file_path, 'wb').write(r.content)
        print('Report file {} downloaded: {}'.format(cpt, file_path))
        cpt += 1

print('Generating access token...')
access_token = get_access_token(
    app_key='<your_api_key>',
    app_secret='<your_api_secret>',
    username='<your_username>',
    password='<your_password>'
)

print('Creating report request...')
report_token = create_report_request(
    access_token=access_token,
    dimensions=('DAY', 'VIDEO_TITLE'),
    metrics=('VIEWS'),
    filters={'videoOwnerChannelSlug': '<your_channel_slug>'},
    start_date='2018-07-01',
    end_date='2018-07-04'
)

download_links = None
while not download_links:
    print('Checking report status...')
    # Checks every 15secs the report status
    time.sleep(15)
    download_links = check_report_status(
        access_token=access_token,
        report_token=report_token
    )

download_report(download_links=download_links)