Ctrlk
Login to HIVO
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Reports

Get cached aggregate asset statistics

get
Authorizations
X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Query parameters
filter[clientId]stringOptional

Admin-only. Client ID to retrieve cached statistics for.

Responses
200

OK

application/json
get/v1/reports/aggregate-asset-stats
GET /api/rest/v1/reports/aggregate-asset-stats HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "timestamp": 1,
    "authentication": "text",
    "links": {
      "me": "https://example.com"
    }
  },
  "links": {
    "self": "https://example.com",
    "thumbnail": {
      "href": "https://example.com",
      "meta": {
        "version": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "data": {
    "type": "aggregate-asset-stats",
    "id": "text",
    "attributes": {
      "updatedAt": 1,
      "entries": [
        {
          "type": "text",
          "ext": "text",
          "count": 1,
          "size": 1,
          "views": 1,
          "dls": 1,
          "originalCount": 1
        }
      ]
    }
  }
}

List asset usage statistics

get

Returns usage counts keyed by asset id with basic asset details (name, category, createdAt). The date range (filter[startTime]..filter[endTime]) must not exceed 366 days.

Authorizations
X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Query parameters
filter[startTime]integerRequired

Inclusive report start date as a Unix timestamp.

filter[endTime]integerRequired

Inclusive report end date as a Unix timestamp.

limitinteger · min: 1 · max: 256OptionalDefault: 32
skipinteger · max: 65536OptionalDefault: 0
sortstring · enumOptionalDefault: -totalViewCountPossible values:
Responses
200

OK

application/json
get/v1/reports/asset-stats
GET /api/rest/v1/reports/asset-stats?filter[startTime]=1&filter[endTime]=1 HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "timestamp": 1,
    "authentication": "text",
    "links": {
      "me": "https://example.com"
    }
  },
  "links": {
    "self": "https://example.com",
    "first": "https://example.com",
    "prev": "https://example.com",
    "next": "https://example.com"
  },
  "data": [
    {
      "type": "asset-stats",
      "id": "text",
      "attributes": {
        "name": "text",
        "category": "image",
        "createdAt": 1,
        "downloadCount": 1,
        "viewCount": 1,
        "sharedViewCount": 1,
        "sharedEmbeddedViewCount": 1,
        "totalViewCount": 1
      },
      "links": {
        "self": "https://example.com",
        "thumbnail": {
          "href": "https://example.com",
          "meta": {
            "version": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

List collection usage statistics

get

Returns usage counts keyed by collection id with basic collection details (name, createdAt). The date range (filter[startTime]..filter[endTime]) must not exceed 366 days.

Authorizations
X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Query parameters
filter[startTime]integerRequired

Inclusive report start date as a Unix timestamp.

filter[endTime]integerRequired

Inclusive report end date as a Unix timestamp.

limitinteger · min: 1 · max: 256OptionalDefault: 32
skipinteger · max: 65536OptionalDefault: 0
sortstring · enumOptionalDefault: -totalViewCountPossible values:
Responses
200

OK

application/json
get/v1/reports/collection-stats
GET /api/rest/v1/reports/collection-stats?filter[startTime]=1&filter[endTime]=1 HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "timestamp": 1,
    "authentication": "text",
    "links": {
      "me": "https://example.com"
    }
  },
  "links": {
    "self": "https://example.com",
    "first": "https://example.com",
    "prev": "https://example.com",
    "next": "https://example.com"
  },
  "data": [
    {
      "type": "collection-stats",
      "id": "text",
      "attributes": {
        "name": "text",
        "createdAt": 1,
        "viewCount": 1,
        "sharedViewCount": 1,
        "totalViewCount": 1
      },
      "links": {
        "self": "https://example.com",
        "thumbnail": {
          "href": "https://example.com",
          "meta": {
            "version": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

List user usage statistics

get
Authorizations
X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Query parameters
filter[startTime]integerRequired

Inclusive report start date as a Unix timestamp.

filter[endTime]integerRequired

Inclusive report end date as a Unix timestamp.

limitinteger · min: 1 · max: 256OptionalDefault: 32
skipinteger · max: 65536OptionalDefault: 0
sortstring · enumOptionalDefault: -pageViewCountPossible values:
Responses
200

OK

application/json
get/v1/reports/user-stats
GET /api/rest/v1/reports/user-stats?filter[startTime]=1&filter[endTime]=1 HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "timestamp": 1,
    "authentication": "text",
    "links": {
      "me": "https://example.com"
    }
  },
  "links": {
    "self": "https://example.com",
    "first": "https://example.com",
    "prev": "https://example.com",
    "next": "https://example.com"
  },
  "data": [
    {
      "type": "user-stats",
      "id": "text",
      "attributes": {
        "name": "text",
        "jobTitle": "text",
        "company": "text",
        "groupIds": [
          "text"
        ],
        "lastActiveAt": 1,
        "pageViewCount": 1,
        "connectionCount": 1
      },
      "links": {
        "self": "https://example.com",
        "thumbnail": {
          "href": "https://example.com",
          "meta": {
            "version": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

List assets not viewed since a specified date

get

Returns assets whose effective last-viewed time is on or before filter[inactiveBefore]. Results are always ordered by oldest effective last-viewed time first.

Authorizations
X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Query parameters
limitinteger · min: 1 · max: 256OptionalDefault: 32
skipinteger · max: 65536OptionalDefault: 0
filter[inactiveBefore]integerRequired

Inclusive Unix-second cutoff. Must be in the past. Assets with an effective last-viewed time on or before this value are returned.

Responses
200

OK

application/json
get/v1/reports/inactive-assets
GET /api/rest/v1/reports/inactive-assets?filter[inactiveBefore]=1 HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "timestamp": 1,
    "authentication": "text",
    "links": {
      "me": "https://example.com"
    }
  },
  "links": {
    "self": "https://example.com",
    "first": "https://example.com",
    "prev": "https://example.com",
    "next": "https://example.com"
  },
  "data": [
    {
      "type": "inactive-assets",
      "id": "text",
      "attributes": {
        "name": "text",
        "viewedAt": 1,
        "views": 1,
        "createdAt": 1,
        "lastModified": 1
      },
      "links": {
        "self": "https://example.com",
        "thumbnail": {
          "href": "https://example.com",
          "meta": {
            "version": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}
PreviousTasksNextModels

Last updated