Reports

Organisation Reports

Endpoints for organisation-level reports

get/shop/reports/organisation/revenue-by-centre

Organisation revenue by centre report

getOrganisationRevenueByCentreReport

Get a report of revenue by centre for all sites in an organisation.

Query parameters

  • revenue_date_fromdateoptional

    Include revenues on or after this date.

  • revenue_date_todateoptional

    Include revenues on or before this date.

  • item_date_fromdateoptional

    Include items taking place on or after this date.

  • item_date_todateoptional

    Include items taking place on or before this date.

  • labelsstring[]optional

    Filter to baskets with the given labels.

  • site_idstring[]optional

    Include data for the given site ID(s).

Responses

  • 200

    Contains the report data

  • 401

    The user is unauthenticated

get/shop/reports/organisation/revenue-by-centre/queue

Queue an export of the organisation revenue by centre report.

actionQueueOrganisationRevenueByCentreReport

This endpoint queues an export of the organisation revenue by centre report.

Query parameters

Responses

  • 200

    The job was successfully queued

  • 400

    The request failed.

  • 401

    The user is unauthenticated

get/shop/reports/organisation/authentication-log

Organisation Authentication log report

getAuthenticationLogReport

This endpoint returns a report of all authentication logs for the organisation.

Query parameters

  • date_fromdaterequired

    The date from which to start the report.

  • date_todaterequired

    The date to which to end the report.

  • authenticatable_iduuidoptional

    Optional user filter. When provided, only authentication events for the given user are returned; omit to see every authentication attempt across the organisation in the date range.

  • login_successfulbooleanoptional

    Filter the report by whether the login was successful or not.

  • pageintegeroptional

    The page to retrieve results from

  • per_pageintegeroptional

    The number of results to return per page

Responses

  • 200

    Contains the report data

  • 401

    The user is unauthenticated

get/shop/reports/organisation/authentication-log/queue

Queue an export of the organisation authentication log report

actionQueueAuthenticationLogReport

This endpoint queues an export of all authentication logs for the organisation.

Query parameters

  • date_fromdaterequired

    The date from which to start the report.

  • date_todaterequired

    The date to which to end the report.

  • authenticatable_iduuidoptional

    Optional user filter. When provided, only authentication events for the given user are returned; omit to see every authentication attempt across the organisation in the date range.

  • login_successfulbooleanoptional

    Filter the report by whether the login was successful or not.

Responses

  • 200

    The job was successfully queued

  • 400

    The request failed.

  • 401

    The user is unauthenticated

get/shop/reports/organisation/revenue-by-sales-channel

Organisation revenue by sales channel report

getOrganisationRevenueBySalesChannelReport

Get a report of revenue by sales channel for all sites in an organisation.

Query parameters

  • revenue_date_fromdateoptional

    Include revenues on or after this date.

  • revenue_date_todateoptional

    Include revenues on or before this date.

  • submitted_at_fromdateoptional

    Include revenues for orders submitted on or after this date.

  • submitted_at_todateoptional

    Include revenues for orders submitted on or before this date.

  • item_date_fromdateoptional

    Include items taking place on or after this date.

  • item_date_todateoptional

    Include items taking place on or before this date.

  • sales_channelstring[]optional

    Include revenues from the given sales channel(s).

  • revenue_centrestring[]optional

    Include revenues with the selected revenue centre(s).

  • site_idstring[]optional

    Include data for the given site ID(s).

Responses

  • 200

    Contains the report data

  • 401

    The user is unauthenticated

get/shop/reports/organisation/revenue-by-sales-channel/queue

Queue an export of the organisation revenue by sales channel report.

actionQueueOrganisationRevenueBySalesChannelReport

This endpoint queues an export of the organisation revenue by sales channel report.

Query parameters

  • revenue_date_fromdateoptional

    Include revenues on or after this date.

  • revenue_date_todateoptional

    Include revenues on or before this date.

  • submitted_at_fromdateoptional

    Include revenues for orders submitted on or after this date.

  • submitted_at_todateoptional

    Include revenues for orders submitted on or before this date.

  • item_date_fromdateoptional

    Include items taking place on or after this date.

  • item_date_todateoptional

    Include items taking place on or before this date.

  • sales_channelstring[]optional

    Include revenues from the given sales channel(s).

  • revenue_centrestring[]optional

    Include revenues with the selected revenue centre(s).

Responses

  • 200

    The job was successfully queued

  • 400

    The request failed.

  • 401

    The user is unauthenticated

get/shop/reports/organisation/top-offerings

Organisation revenue by centre report

getOrganisationTopOfferingsReport

Get a report of top offerings across all sites in an organisation.

Query parameters

  • revenue_date_fromdateoptional

    Include revenues on or after this date.

  • revenue_date_todateoptional

    Include revenues on or before this date.

  • date_fromdateoptional

    Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

  • date_todateoptional

    Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

  • offering_typestring[]optional

    Include items of this type.

Responses

  • 200

    Contains the report data

  • 401

    The user is unauthenticated

get/shop/reports/organisation/top-offerings/queue

Queue an export of the organisation top offerings report.

actionQueueOrganisationTopOfferingsReport

This endpoint queues an export of the organisation top offerings report.

Query parameters

  • revenue_date_fromdateoptional

    Include revenues on or after this date.

  • revenue_date_todateoptional

    Include revenues on or before this date.

  • date_fromdateoptional

    Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

  • date_todateoptional

    Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

  • offering_typestring[]optional

    Include items of this type.

Responses

  • 200

    The job was successfully queued

  • 400

    The request failed.

  • 401

    The user is unauthenticated