Evo Voice

CustomMetricReport

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
All Verbs	/reports/metric

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 ReportRequest(IReturn[ReportInfo], IPost):
    # @ApiMember(Description="The account ID this report should be run for")
    account_id: Optional[str] = None
    """
    The account ID this report should be run for
    """


    # @ApiMember(Description="The email address to notify after the report is run")
    email_address_to_notify: Optional[str] = None
    """
    The email address to notify after the report is run
    """


    # @ApiMember(Description="The webhook to call after the report is complete with the data from the report")
    webhook_url: Optional[str] = None
    """
    The webhook to call after the report is complete with the data from the report
    """
    @staticmethod
    def response_type(): return ReportInfo


class ReportStatuses(str, Enum):
    QUEUED = 'Queued'
    RUNNING = 'Running'
    COMPLETED = 'Completed'
    ERROR = 'Error'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportInfo:
    id: Optional[str] = None
    name: Optional[str] = None
    status: Optional[ReportStatuses] = None
    status_message: Optional[str] = None
    date_created: Optional[str] = None
    date_updated: Optional[str] = None
    download_link: Optional[str] = None
    job_id: Optional[str] = None
    email_address_to_notify: Optional[str] = None
    server: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomMetricReport(ReportRequest):
    start_date: Optional[str] = None
    end_date: Optional[str] = None
    metric_name: Optional[str] = None
    time_zone_id: Optional[str] = None

Python CustomMetricReport 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.

POST /reports/metric HTTP/1.1 
Host: evovoice.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"startDate":"String","endDate":"String","metricName":"String","timeZoneId":"String","accountId":"String","emailAddressToNotify":"String","webhookUrl":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":"String","name":"String","status":"Queued","statusMessage":"String","dateCreated":"String","dateUpdated":"String","downloadLink":"String","jobId":"String","emailAddressToNotify":"String","server":"String"}