Skip to content

Latest commit

 

History

History
144 lines (100 loc) · 4.73 KB

ReportsApi.md

File metadata and controls

144 lines (100 loc) · 4.73 KB
Raw

Phrase\ReportsApi

All URIs are relative to https://api.phrase.com/v2

Method HTTP request Description
reportLocalesList GET /projects/{project_id}/report/locales List Locale Reports
reportShow GET /projects/{project_id}/report Get Project Report

reportLocalesList

\Phrase\Model\LocaleReport[] reportLocalesList($project_id, $x_phrase_app_otp, $page, $per_page, $locale_codes, $tag, $branch)

List Locale Reports

List all locale reports for the given project

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token');

$apiInstance = new Phrase\Api\ReportsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_id = 'project_id_example'; // string | Project ID
$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)
$page = 1; // int | Page number
$per_page = 25; // int | Limit on the number of objects to be returned, between 1 and 100. 25 by default
$locale_codes = 'locale_codes_example'; // string | Locale Code
$tag = 'tag_example'; // string | tag
$branch = my-feature-branch; // string | specify the branch to use

try {
    $result = $apiInstance->reportLocalesList($project_id, $x_phrase_app_otp, $page, $per_page, $locale_codes, $tag, $branch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->reportLocalesList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
project_id string Project ID
x_phrase_app_otp string Two-Factor-Authentication token (optional) [optional]
page int Page number [optional]
per_page int Limit on the number of objects to be returned, between 1 and 100. 25 by default [optional]
locale_codes string Locale Code [optional]
tag string tag [optional]
branch string specify the branch to use [optional]

Return type

\Phrase\Model\LocaleReport[]

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reportShow

\Phrase\Model\ProjectReport reportShow($project_id, $x_phrase_app_otp, $branch)

Get Project Report

Get report of a single project.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = Phrase\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = Phrase\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'token');

$apiInstance = new Phrase\Api\ReportsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$project_id = 'project_id_example'; // string | Project ID
$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)
$branch = my-feature-branch; // string | specify the branch to use

try {
    $result = $apiInstance->reportShow($project_id, $x_phrase_app_otp, $branch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->reportShow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
project_id string Project ID
x_phrase_app_otp string Two-Factor-Authentication token (optional) [optional]
branch string specify the branch to use [optional]

Return type

\Phrase\Model\ProjectReport

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]