Skip to main content Link Search Menu Expand Document (external link)

Updated Thu Sep 22nd 2022, 19:00 UTC

Account Analytics

GET /:account/analytics

This will return a list of all analytics categories available and reports available within each section

Examples

Getting a list of available Analytics Categories and reports within

Request

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

Response

Status

200

Response Type

hydra:Collection

Example Body

{
  "@type": "hydra:Collection",
  "@context": "/contexts/hydra:Collection.jsonld",
  "id": "/my_account/analytics",
  "members": [
    {
      "@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
      }
    }
  ],
  "totalItems": 1
}

Table of contents


© 2022 TextUs