CoreService

<back to all web services

GetStatisticsSummary

Statistics

Gets statistic like Resources by OsTypes, etc.

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
GET/api/statistics/summaryGets statistics like Resources by OsTypes, etc.
GET/statistics/summaryGets statistics like Resources by OsTypes, etc.
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum StatisticsDataType : string
{
    case SingleDatapoint = 'SingleDatapoint';
    case SingleDataset = 'SingleDataset';
    case MultiDataset = 'MultiDataset';
}

/**
 * @property string $name
 * @property StatisticsDataType $type
 */
interface IStatisticsData
{
}

class StatisticsSummaryDto implements JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $generatedOn=new DateTime(),
        /** @var array<string,IStatisticsData>|null */
        public ?array $statistics=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['generatedOn'])) $this->generatedOn = JsonConverters::from('DateTime', $o['generatedOn']);
        if (isset($o['statistics'])) $this->statistics = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','IStatisticsData']), $o['statistics']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->generatedOn)) $o['generatedOn'] = JsonConverters::to('DateTime', $this->generatedOn);
        if (isset($this->statistics)) $o['statistics'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','IStatisticsData']), $this->statistics);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Gets statistic like Resources by OsTypes, etc. */
// @Api(Description="Gets statistic like Resources by OsTypes, etc.")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType="typeof(CoreService.ServiceModel.Dtos.Statistics.Responses.StatisticsSummaryDto)", StatusCode=200)
class GetStatisticsSummary implements IBaseRequest, IHasTenantName, IGet, JsonSerializable
{
    public function __construct(
        // @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
        // @Validate(Validator="NotEmpty")
        /** @var string */
        public string $tenantName=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['tenantName'])) $this->tenantName = $o['tenantName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->tenantName)) $o['tenantName'] = $this->tenantName;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetStatisticsSummary DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/statistics/summary HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"generatedOn":"0001-01-01T00:00:00.0000000Z","statistics":{"String":null}}