query-api.d.ts

/* Autogenerated, recreate with `npm run --prefix assets generate-types` */

export type Metric =
  | "visitors"
  | "visits"
  | "pageviews"
  | "views_per_visit"
  | "bounce_rate"
  | "visit_duration"
  | "events"
  | "percentage"
  | "conversion_rate"
  | "group_conversion_rate"
  | "time_on_page"
  | "total_revenue"
  | "average_revenue"
  | "scroll_depth";
export type DateRangeShorthand =
  | "all"
  | "day"
  | "24h"
  | "7d"
  | "28d"
  | "30d"
  | "91d"
  | "month"
  | "6mo"
  | "12mo"
  | "year"
  | string;
/**
 * @minItems 2
 * @maxItems 2
 */
export type DateTimeRange = [string, string];
/**
 * @minItems 2
 * @maxItems 2
 */
export type DateRange = [string, string];
export type Dimensions = SimpleFilterDimensions | CustomPropertyFilterDimensions | GoalDimension | TimeDimensions;
export type SimpleFilterDimensions =
  | "event:name"
  | "event:page"
  | "event:hostname"
  | "event:label"
  | "visit:source"
  | "visit:channel"
  | "visit:referrer"
  | "visit:utm_medium"
  | "visit:utm_source"
  | "visit:utm_campaign"
  | "visit:utm_content"
  | "visit:utm_term"
  | "visit:screen"
  | "visit:device"
  | "visit:browser"
  | "visit:browser_version"
  | "visit:os"
  | "visit:os_version"
  | "visit:country"
  | "visit:region"
  | "visit:city"
  | "visit:country_name"
  | "visit:region_name"
  | "visit:city_name"
  | "visit:entry_page"
  | "visit:exit_page"
  | "visit:entry_page_hostname"
  | "visit:exit_page_hostname";
export type CustomPropertyFilterDimensions = string;
export type GoalDimension = "event:goal";
export type TimeDimensions = "time" | "time:month" | "time:week" | "time:day" | "time:hour";
export type FilterTree = FilterEntry | FilterAndOr | FilterNot | FilterHasDone | FilterSequence;
export type FilterEntry = FilterWithoutGoals | FilterWithIs | FilterWithContains | FilterWithPattern;
/**
 * @minItems 3
 * @maxItems 4
 */
export type FilterWithoutGoals =
  | [FilterOperationWithoutGoals, SimpleFilterDimensions | CustomPropertyFilterDimensions, Clauses]
  | [
      FilterOperationWithoutGoals,
      SimpleFilterDimensions | CustomPropertyFilterDimensions,
      Clauses,
      {
        case_sensitive?: boolean;
      }
    ];
/**
 * filter operation
 */
export type FilterOperationWithoutGoals = "is_not" | "contains_not";
export type Clauses = (string | number)[];
/**
 * @minItems 3
 * @maxItems 4
 */
export type FilterWithIs =
  | ["is", GoalDimension | SimpleFilterDimensions | CustomPropertyFilterDimensions | "segment", Clauses]
  | [
      "is",
      GoalDimension | SimpleFilterDimensions | CustomPropertyFilterDimensions | "segment",
      Clauses,
      {
        case_sensitive?: boolean;
      }
    ];
/**
 * @minItems 3
 * @maxItems 4
 */
export type FilterWithContains =
  | ["contains", GoalDimension | SimpleFilterDimensions | CustomPropertyFilterDimensions, Clauses]
  | [
      "contains",
      GoalDimension | SimpleFilterDimensions | CustomPropertyFilterDimensions,
      Clauses,
      {
        case_sensitive?: boolean;
      }
    ];
/**
 * @minItems 3
 * @maxItems 3
 */
export type FilterWithPattern = [
  FilterOperationRegex,
  SimpleFilterDimensions | CustomPropertyFilterDimensions,
  Clauses
];
/**
 * filter operation
 */
export type FilterOperationRegex = "matches" | "matches_not";
/**
 * @minItems 2
 * @maxItems 2
 */
export type FilterAndOr = ["and" | "or", [FilterTree, ...FilterTree[]]];
/**
 * @minItems 2
 * @maxItems 2
 */
export type FilterNot = ["not", FilterTree];
/**
 * @minItems 2
 * @maxItems 2
 */
export type FilterHasDone = ["has_done" | "has_not_done", FilterTree];
/**
 * @minItems 2
 * @maxItems 2
 */
export type FilterSequence = ["sequence", [FilterTree, ...FilterTree[]]];
/**
 * @minItems 2
 * @maxItems 2
 */
export type OrderByEntry = [
  Metric | SimpleFilterDimensions | CustomPropertyFilterDimensions | TimeDimensions,
  "asc" | "desc"
];

export interface QueryApiSchema {
  /**
   * Domain of site to query
   */
  site_id: string;
  /**
   * List of metrics to query
   *
   * @minItems 1
   */
  metrics: [Metric, ...Metric[]];
  /**
   * Date range to query
   */
  date_range: DateRangeShorthand | DateTimeRange | DateRange;
  /**
   * What to group the results by. Same as `property` in Plausible API v1
   */
  dimensions?: Dimensions[];
  /**
   * How to drill into your data
   */
  filters?: FilterTree[];
  /**
   * How to order query results
   */
  order_by?: OrderByEntry[];
  include?: {
    time_labels?: boolean;
    imports?: boolean;
    /**
     * If set, returns the total number of result rows rows before pagination under `meta.total_rows`
     */
    total_rows?: boolean;
    /**
     * If set and using `day`, `month` or `year` date_ranges, the query will be trimmed to the current date
     */
    trim_relative_date_range?: boolean;
  };
  pagination?: {
    /**
     * Number of rows to limit result to.
     */
    limit?: number;
    /**
     * Pagination offset.
     */
    offset?: number;
  };
}