reports

Resource: report

This link relationship returns a collection of reports. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

Required Scopes

Full store_full_access
Read reporting_read
Write reporting_write

Collection Resource

report

Actions

GET View a list of reports
POST Create a new report
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:reports[] — array of report resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/stores/{store_id}/reports
Available via fx:reports on store

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/reports",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/reports?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/reports?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/reports?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/reports?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:reports": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/reports/456",
            "title": "This Report"
          },
          "fx:download_url": {
            "href": "https://api.foxycart.com/download_url",
            "title": "Download This Report"
          },
          "fx:user": {
            "href": "https://api.foxycart.com/users/456",
            "title": "This User"
          }
        },
        "name": "complete",
        "version": "1",
        "datetime_start": "2022-01-01T00:00:00-0800",
        "datetime_end": "2022-01-31T23:59:59-0800",
        "status": "ready",
        "date_created": "2022-03-11T17:38:02-0800",
        "date_modified": "2022-03-11T17:38:38-0800"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}