| GET | /v1/links/report |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Item:
id: Optional[str] = None
display_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportData:
id: Optional[str] = None
item: Optional[Item] = None
total_clicks: int = 0
actual_clicks: int = 0
junk_clicks: int = 0
spider_clicks: int = 0
date_utc: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Error:
code: Optional[str] = None
class GroupBy(str, Enum):
DEFAULT = 'Default'
RETAILER = 'Retailer'
DATE = 'Date'
class ReportType(str, Enum):
SHORT_URL = 'ShortUrl'
GROUP = 'Group'
USER = 'User'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportRequest:
items: Optional[List[str]] = None
group_by: Optional[List[GroupBy]] = None
attribute: Optional[str] = None
type: Optional[ReportType] = None
from_start_utc_inclusive: datetime.datetime = datetime.datetime(1, 1, 1)
from_end_utc_inclusive: datetime.datetime = datetime.datetime(1, 1, 1)
retailers: Optional[List[str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Report(Report):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ClickReport:
code: Optional[str] = None
reports: Optional[Dict[str, Report]] = None
total_clicks: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetLinkReportResponse:
report: Optional[ClickReport] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetLinkReportRequest:
base_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Report:
data: Optional[List[ReportData]] = None
execution_time_ms: int = 0
total_items: int = 0
errors: Optional[List[Error]] = None
request: Optional[ReportRequest] = None
total_clicks: int = 0
Python GetLinkReportRequest 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/links/report HTTP/1.1 Host: api.booklinker.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"reports":{"code":"String","reports":{"String":{"data":[{"id":"String","item":{"id":"String","displayName":"String"},"totalClicks":0,"clicks":0,"junkClicks":0,"spiderClicks":0,"dateUtc":"0001-01-01T00:00:00.0000000"}],"executionTimeMs":0,"totalItems":1,"errors":[{}],"request":{"attribute":"String","type":"ShortUrl","fromStartUtcInclusive":"0001-01-01T00:00:00.0000000","fromEndUtcInclusive":"0001-01-01T00:00:00.0000000"},"totalClicks":0}},"totalClicks":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}