Statistics API V1

Get statistics

A feladott tételekről ad vissza statisztikát. A lekérdezést csak meghatározott időintervallumra (fromDate - todate) lehet indítani. A granularity mezővel szabályozhatjuk, hogy az eredményeket milyen időintervallumra szeretnénk aggregálni (nap, hét, hónap, év), de akár üresen is hagyhatjuk, mert nem kérünk aggregációt. Megadhatunk szűrőfeltéteket (filters) és egyéb aggregálási dimenziókat dimensions is.

Web service API [DEPRECATED]

Kérés

Név	Típus	Leírás
clientHashKey	String	A hívó kliens azonosítója.
userName	String	A felhasználó neve.
params	Param_V1 [ ]	Egyéb meta adatok.
orders	Order [ ]	Rendezések.
statName	String	A kért statisztika neve.
filters	Filter [ ]	Szűrési feltételek.
dimensionNames	String [ ]	Az időn kívül mely más mezőkre aggregálunk.
fromDate	DateTime	A lekérdezési intervallum kezdete (inclusive).
toDate	DateTime	A lekérdezési intervallum vége (inclusive).
granularity	String	Az eredményeket milyen granularitásban kérjük.

statName: MAIL_STAT
granularity: DAY, WEEK, MONTH, YEAR
dimensions: MESSAGE_TYPE, STATUS

Válasz

Név	Típus	Leírás
statistics	Statistic [ ]	Statisztikák.
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

Lekérdezés 2 napra GFB.KOTVENY típusra, STATUS szerint aggregálva.

KérésVálasz

<request>
    <clientHashKey>?</clientHashKey>
    <statName>?</statName>
    <fromDate>2018-05-01</fromDate>
    <toDate>2018-05-02</toDate>
    <granularity>DAY</granularity>
    <filters>
        <filter>
            <field>MESSAGE_TYPE</field>
            <operator>EQUALS</operator>
            <value>GFB.KOTVENY</value>
        </filter>
    </filters>
    <dimensionNames>
        <dimensionName>STATUS</dimensionName>
    </dimensionNames>
</request>

<response>
    <statistics>
        <statistic>
            <from>2018-05-01</from>
            <to>2018-05-01</to>
            <dimensions>
            <dimension>
                <name>STATUS</name>
                <value>SENT<value>
            </dimension>
            </dimension>
            <values>
                <statValue>
                    <name>TOTAL</name>
                    <value>5</value>
                </statValue>
            </values>
        </statistic>
        <statistic>
            <from>2018-05-01</from>
            <to>2018-05-01</to>
            <dimensions>
            <dimension>
                <name>STATUS</name>
                <value>BOUNCED<value>
            </dimension>
        </dimension>
            <values>
            <statValue>
                <name>TOTAL</name>
                <value>5</value>
            </statValue>
            </values>
        </statistic>
        <statistic>
            <from>2018-05-02</from>
            <to>2018-05-01</to>
            <dimensions>
            <dimension>
                <name>STATUS</name>
                <value>SENT<value>
            </dimension>
            </dimension>
            <values>
            <statValue>
                <name>TOTAL</name>
                <value>5</value>
            </statValue>
            </values>
        </statistic>
        </statistics>
    <status>
    ...
    </status>
</response>

REST API

REST API Info

Kérés

GET hammy/json/statistics/v1/statistics

A szűrési paramétereket az URL-ben a jQuery.param() függvény 1.4-es verziója szerinti formában kell megadni.

Paraméter	Típus	Leírás
uuid	String	A kérés UUID-ja. (vnd.api ID)
statName	String	A kért statisztika neve.
filters	JStatisticsRequestFilter1 [ ]	Szűrési feltételek.
dimensionNames	String [ ]	Az időn kívül mely más mezőkre aggregálunk.
fromDate	DateTime	A lekérdezési intervallum kezdete (inclusive).
toDate	DateTime	A lekérdezési intervallum vége (inclusive).
granularity	String	Az eredményeket milyen granularitásban kérjük.

Válasz

Név	Típus	Leírás
meta	JListMeta1	A válaszhoz tartozó metaadatok.
list	JStatistic1 [ ]	A kért statisztikák.

Minta

KérésVálasz

GET /hammy/json/statistics/v1/statistics?clientHashKey={{clientHashKey}}&statName=MAIL_STAT&fromDate=2018-09-05&toDate=2018-09-06&granularity=DAY&filters%5B0%5D%5Bfield%5D=MESSAGE_TYPE&filters%5B0%5D%5Boperator%5D=EQUALS&filters%5B0%5D%5Bvalue%5D=GFB.KOTVENY&dimensionNames%5B%5D=STATUS
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
        {
            "type": "statistics",
            "id": "8f849d90-4dfc-49fb-b12b-0f5725c8aa84",
            "attributes": {
                "fromDate": "2018-09-04T22:00:00.000+0000",
                "toDate": "2018-09-04T22:00:00.000+0000",
                "dimensions": [
                    {
                        "name": "STATUS",
                        "value": "ARCHIVED"
                    }
                ],
                "values": [
                    {
                        "name": "TOTAL",
                        "value": 0
                    }
                ]
            }
        },
        {
            "type": "statistics",
            "id": "90579dc1-6718-4c9c-aa50-8ac455a5fdb9",
            "attributes": {
                "fromDate": "2018-09-04T22:00:00.000+0000",
                "toDate": "2018-09-04T22:00:00.000+0000",
                "dimensions": [
                    {
                        "name": "STATUS",
                        "value": "BLOCKED"
                    }
                ],
                "values": [
                    {
                        "name": "TOTAL",
                        "value": 0
                    }
                ]
            }
        },
        {
            "type": "statistics",
            "id": "c2a5e130-c5cf-4ea7-a958-fd1b2caae226",
            "attributes": {
                "fromDate": "2018-09-04T22:00:00.000+0000",
                "toDate": "2018-09-04T22:00:00.000+0000",
                "dimensions": [
                    {
                        "name": "STATUS",
                        "value": "CANCELLED"
                    }
                ],
                "values": [
                    {
                        "name": "TOTAL",
                        "value": 0
                    }
                ]
            }
        },
        {
            "type": "statistics",
            "id": "08ccc33a-f04d-4880-83b8-b5a6b50e15f5",
            "attributes": {
                "fromDate": "2018-09-04T22:00:00.000+0000",
                "toDate": "2018-09-04T22:00:00.000+0000",
                "dimensions": [
                    {
                        "name": "STATUS",
                        "value": "DELIVERY_SKIPPED"
                    }
                ],
                "values": [
                    {
                        "name": "TOTAL",
                        "value": 0
                    }
                ]
            }
        },
        {
            "type": "statistics",
            "id": "9add516f-462b-4f8d-9fa4-75370f0a1eab",
            "attributes": {
                "fromDate": "2018-09-04T22:00:00.000+0000",
                "toDate": "2018-09-04T22:00:00.000+0000",
                "dimensions": [
                    {
                        "name": "STATUS",
                        "value": "ERROR"
                    }
                ],
                "values": [
                    {
                        "name": "TOTAL",
                        "value": 0
                    }
                ]
            }
        },
        {
            "type": "statistics",
            "id": "ccc6703e-ad39-47d4-a948-02ad255b4d7e",
            "attributes": {
                "fromDate": "2018-09-04T22:00:00.000+0000",
                "toDate": "2018-09-04T22:00:00.000+0000",
                "dimensions": [
                    {
                        "name": "STATUS",
                        "value": "FAILED"
                    }
                ],
                "values": [
                    {
                        "name": "TOTAL",
                        "value": 0
                    }
                ]
            }
        },

        ...
    ],
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}

Send statistics

Statisztika küldése.

Web service API

Kérés

Név	Típus	Leírás
clientHashKey	String	A hívó kliens azonosítója.

Válasz

Név	Típus	Leírás
status	ResponseStatus_V1	A válasz státusza.
params	Param_V1 [ ]	Egyéb paraméterek listája.

Minta

KérésVálasz

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:stat="http://statistics.api.hammy.dbx.hu/">
    <soapenv:Header/>
    <soapenv:Body>
        <stat:sendStatistics>
            <request>
                <clientHashKey>?</clientHashKey>
            </request>
        </stat:sendStatistics>
    </soapenv:Body>
</soapenv:Envelope>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <S:Body>
      <ns2:sendStatisticsResponse xmlns:ns2="http://statistics.api.hammy.dbx.hu/">
         <response>
            <status>
               <code>0</code>
               <messages/>
            </status>
            <params/>
         </response>
      </ns2:sendStatisticsResponse>
   </S:Body>
</S:Envelope>

REST API

REST API Info

Kérés

GET hammy/json/statistics/v1/send

Paraméter	Típus	Leírás
requestMeta	JRequestMeta_V1	A kérés metaadatai.

Válasz

Név	Típus	Leírás
meta	JMeta1	Metaadatok.

Minta

KérésVálasz

GET /hammy/json/statistics/v1/send?clientHashKey={{clientHashKey}}
Authorization: JWT {{jwtToken}}
X-Client-Hash-Key: {{clientHashKey}}
X-User-Name: {{userName}}

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "type": "emptyResponse",
        "id": "dc295a5e-aa93-4342-9444-04c1c2f939b1",
        "attributes": {}
    },
    "meta": {
        "total": null,
        "params": [],
        "responseStatus": {
            "code": 0,
            "messages": []
        }
    }
}