Link Search Menu Expand Document

Updated Wed Jul 6th 2022, 18:32 UTC

Index

GET /:account/analytics/:section

This will return a list of all analytic reports that pertain to the given section from the URL.

Examples

Getting a list of available Analytics Reports within said Category

Request

GET /my_account/analytics/overview
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /my_account/analytics/overview
    

Response

Status

200

Response Type

AnalyticsSection

Example
{
  "@type": "AnalyticsSection",
  "@context": "/contexts/AnalyticsSection.jsonld",
  "id": "/my_account/analytics/overview",
  "title": "Overview",
  "description": "General account overview statistics",
  "slug": "overview",
  "reports": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "members": [
      {
        "@type": "AnalyticsReport",
        "@context": "/contexts/AnalyticsReport.jsonld",
        "id": "/my_account/analytics/overview/user_engagement",
        "title": "User Engagement",
        "slug": "user_engagement"
      }
    ],
    "totalItems": 3
  }
}

Table of contents


© 2022 TextUs