All Products
Search
Document Center

QuerySingleReport

Last Updated: Jan 15, 2021

QuerySingleReport

Description

Queries a single table report. (More report types will be supported.)

Method

GET

URI

/openapi/instances/{instanceId}/sync-reports/single-report

Request parameters

Parameter

Type

Description

Remarks

reportType

String

The type of the single table report.

Required

Valid values: typeItemValidScene, typeItemTag, typeItemTagScene, typeItemWeightScene, typeItemRawScene, and typeItemExpireScene.

Response parameters

Parameter

Type

Description

RequestId

String

The ID of the request.

Result

Map

The result that is returned.

Sample requests

GET /openapi/instances/airec-cn-xxxxx/sync-reports/single-report?reportType=xxx

Sample responses

  • reportType = typeItemValidScene

    {
     "RequestId": "16B78383-2803-4964-9605-37B30C073B0E",
     "Result": [
        {
           "ItemScene": "1_0:1",
           "ItemValidCount": 1
          },
          {
           "ItemScene": "1_0:0",
           "ItemValidCount": 2
          }
         ]
    }
  • reportType = typeItemTag

    {
     "RequestId": "16B78383-2803-4964-9605-37B30C073B0E",
     "Result": [
        {
           "ItemTagRate": 0.6914764284749426,
           "ItemTag": "No coupon",
           "ItemTagCount": 5119
          },
          {
           "ItemTagRate": 0.00013508037282182898,
           "ItemTag": "4",
           "ItemTagCount": 1
          },
        {
           "ItemTagRate": 0.3083884911522356,
           "ItemTag": "Available coupon",
           "ItemTagCount": 2283
        }
         ]
    }
  • reportType = typeItemTagScene

    {
     "RequestId": "16B78383-2803-4964-9605-37B30C073B0E",
     "Result": [
        {
           "ItemTag": "No coupon",
           "ItemScene": "9_0:1",
           "ItemTagCount": 46
          },
          {
           "ItemTag": "No coupon",
           "ItemScene": "1_0:0",
           "ItemTagCount": 1
          }
         ]
    }
  • reportType = typeItemWeightScene

    {
     "RequestId": "16B78383-2803-4964-9605-37B30C073B0E",
     "Result": [
       {
        "ItemValidWeightRate": 0,
        "ItemValidNoWeightRate": 0,
        "ItemScene": "2_0:0",
        "ItemValidWeightCount": 0,
        "ItemValidNoWeightCount": 1,
        "ItemValidCount": 1
      },
      {
        "ItemValidWeightRate": 0,
        "ItemValidNoWeightRate": 0,
        "ItemScene": "7_0:1",
        "ItemValidWeightCount": 0,
        "ItemValidNoWeightCount": 3,
        "ItemValidCount": 3
      }
         ]
    }
  • reportType = typeItemRawScene

    {
     "RequestId": "16B78383-2803-4964-9605-37B30C073B0E",
     "Result": [
       {
        "ItemValidRawCount": 0,
        "ItemValidNoRawCount": 332,
        "ItemValidRawRate": 0,
        "ItemValidNoRawRate": 0,
        "ItemScene": "9_0:0",
        "ItemValidCount": 332
      },
      {
        "ItemValidRawCount": 0,
        "ItemValidNoRawCount": 3,
        "ItemValidRawRate": 0,
        "ItemValidNoRawRate": 0,
        "ItemScene": "7_0:1",
        "ItemValidCount": 3
      }       
     ]
    }
  • reportType = typeItemExpireScene

    {
     "RequestId": "16B78383-2803-4964-9605-37B30C073B0E",
     "Result": [
       {
        "ItemValidExpireRate": 0,
        "ItemValidNoExpireRate": 0,
        "ItemScene": "2_0:0",
        "ItemValidExpireCount": 1,
        "ItemValidNoExpireCount": 0,
        "ItemValidCount": 1
      },
      {
        "ItemValidExpireRate": 0,
        "ItemValidNoExpireRate": 0,
        "ItemScene": "1_0:0",
        "ItemValidExpireCount": 1,
        "ItemValidNoExpireCount": 0,
        "ItemValidCount": 1
      }
        ]
    }