Collection Geo Distribution

Provides Collection Geo distribution of a project
📣 this endpoint provides geo distribution of a collection in project

✳ list of request query parameters

start_time

end_time

group_by = geo_region

🔰 this endpoint gives total geo distributed usage of contents of the contents of a collection in a project

📢 Info message : Here URL is contructed like
GET

/projects/<project_id>/collections/<collection_id>/analytics/geo-distribution?start_time=<time>&end_time=<time>&group_by=geo_region

here time should be formated in RFC3339

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

projId

string

required

Example:

66a1084b-4b6b-4001-a4ad-d34d13463068

collectionId

string

required

Example:

c2ffaea1-c967-4672-b5bc-789144d58b3d

analyticsType

string

required

Example:

geo-distribution

Query Params

start_time

string

optional

Example:

2024-02-24T17:59:59.999Z

end_time

string

optional

Example:

2024-03-02T17:59:59.999Z

group_by

string

optional

Example:

geo_region

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

message

string

required

result

object

required

message

string

required

result

object

required

success

boolean

required

Examples

SuccessSuccess

{"message":"collection analytics was found.","result":{"message":"Dataset retrieved successfully","result":{"filters":[{"field":"media_series","operator":"equal","values":["c2ffaea1-c967-4672-b5bc-789144d58b3d"]}],"group_bys":["media_series"],"metrics":[{"data":[{"media_series":"c2ffaea1-c967-4672-b5bc-789144d58b3d","total_media_views":209}],"filters":null,"group_bys":["media_series"],"name":"total_media_views"}]}},"success":true}

🟢200OK