Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Report

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:report"

links

links: { fx:download_url: DownloadUrl; fx:user: User; self: Report }

Type declaration

props

props: { date_created: null | string; date_modified: null | string; datetime_end: string; datetime_start: string; name: "complete" | "customers" | "customers_ltv"; status: "queued" | "error" | "ready"; version: "1" }

Type declaration

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • datetime_end: string

    Same as datetime_start, but for the end of the report's timeframe. Note that you likely want to pass 23:59:59 as the time portion, or you may inadvertently miss data from the last day of the reporting period.

  • datetime_start: string

    A timestamp in the YYYY-MM-DD HH:MM:SS format, for the start of the reporting period, for your store's configured timezone. Note that any offset will be ignored, and the datetime passed in will be used as your store's configured timezone.

  • name: "complete" | "customers" | "customers_ltv"

    The type of report generated, indicating the content of the report. complete includes transaction details, summaries, coupon usage, subscription forecasts, and more. customers is for exporting customers to import elsewhere. customers_ltv includes the lifetime value per customer.

  • status: "queued" | "error" | "ready"

    Current status of the report. Possible values include queued, error, and ready.

  • version: "1"

    In the event a report changes significantly, a new version of the report may be available. Leave this empty to retrieve the latest version, or pass a 1 to request a specific version. In the future, additional versions of each named report may be available.

Optional Readonly zooms

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc