PopularityInsights¶
Detailed information about an asset's usage or popularity based on aggregated queries.
Complete reference
This is a complete reference for the PopularityInsights
struct in Atlan, showing all of its embedded properties. For an introduction, you probably want to start with:
Embedded properties¶
These are the attributes embedded within each instance of the PopularityInsights
struct in an asset:
recordUser
Username or email of the user who ran the queries. | |
---|---|
1 2 |
|
-
Set the
recordUser
for aPopularityInsights
. -
Retrieve the
recordUser
from aPopularityInsights
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
recordQuery
Query run at source. | |
---|---|
1 2 |
|
-
Set the
recordQuery
for aPopularityInsights
. -
Retrieve the
recordQuery
from aPopularityInsights
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
recordQueryDuration
Duration for which the query ran at source. | |
---|---|
1 2 |
|
-
Set the
recordQueryDuration
for aPopularityInsights
. -
Retrieve the
recordQueryDuration
from aPopularityInsights
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
recordQueryCount
Number of queries run by the user. | |
---|---|
1 2 |
|
-
Set the
recordQueryCount
for aPopularityInsights
. -
Retrieve the
recordQueryCount
from aPopularityInsights
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
recordTotalUserCount
Total number of users who ran queries. | |
---|---|
1 2 |
|
-
Set the
recordTotalUserCount
for aPopularityInsights
. -
Retrieve the
recordTotalUserCount
from aPopularityInsights
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
recordComputeCost
Total compute cost for running all queries. | |
---|---|
1 2 |
|
-
Set the
recordComputeCost
for aPopularityInsights
. -
Retrieve the
recordComputeCost
from aPopularityInsights
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
recordMaxComputeCost
Maximum compute cost across all query runs. | |
---|---|
1 2 |
|
-
Set the
recordMaxComputeCost
for aPopularityInsights
. -
Retrieve the
recordMaxComputeCost
from aPopularityInsights
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
recordComputeCostUnit
Unit of measure for recordComputeCost. | |
---|---|
1 2 |
|
-
Set the
recordComputeCostUnit
for aPopularityInsights
. -
Retrieve the
recordComputeCostUnit
from aPopularityInsights
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
recordLastTimestamp
Timestamp of last operation or query run by the user. | |
---|---|
1 2 |
|
-
Set the
recordLastTimestamp
for aPopularityInsights
. -
Retrieve the
recordLastTimestamp
from aPopularityInsights
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
recordWarehouse
Name of the warehouse on which the queries were run. | |
---|---|
1 2 |
|
-
Set the
recordWarehouse
for aPopularityInsights
. -
Retrieve the
recordWarehouse
from aPopularityInsights
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
recordUser
Username or email of the user who ran the queries. | |
---|---|
1 2 3 4 5 |
|
-
Set the
recordUser
for aPopularityInsights
.For more details
For more information, see the asset CRUD snippets.
recordQuery
Query run at source. | |
---|---|
1 2 3 4 5 |
|
-
Set the
recordQuery
for aPopularityInsights
.For more details
For more information, see the asset CRUD snippets.
recordQueryDuration
Duration for which the query ran at source. | |
---|---|
1 2 3 4 5 |
|
-
Set the
recordQueryDuration
for aPopularityInsights
.For more details
For more information, see the asset CRUD snippets.
recordQueryCount
Number of queries run by the user. | |
---|---|
1 2 3 4 5 |
|
-
Set the
recordQueryCount
for aPopularityInsights
.For more details
For more information, see the asset CRUD snippets.
recordTotalUserCount
Total number of users who ran queries. | |
---|---|
1 2 3 4 5 |
|
-
Set the
recordTotalUserCount
for aPopularityInsights
.For more details
For more information, see the asset CRUD snippets.
recordComputeCost
Total compute cost for running all queries. | |
---|---|
1 2 3 4 5 |
|
-
Set the
recordComputeCost
for aPopularityInsights
.For more details
For more information, see the asset CRUD snippets.
recordMaxComputeCost
Maximum compute cost across all query runs. | |
---|---|
1 2 3 4 5 |
|
-
Set the
recordMaxComputeCost
for aPopularityInsights
.For more details
For more information, see the asset CRUD snippets.
recordComputeCostUnit
Unit of measure for recordComputeCost. | |
---|---|
1 2 3 4 5 |
|
-
Set the
recordComputeCostUnit
for aPopularityInsights
.For more details
For more information, see the asset CRUD snippets.
recordLastTimestamp
Timestamp of last operation or query run by the user. | |
---|---|
1 2 3 4 5 |
|
-
Set the
recordLastTimestamp
for aPopularityInsights
.For more details
For more information, see the asset CRUD snippets.
recordWarehouse
Name of the warehouse on which the queries were run. | |
---|---|
1 2 3 4 5 |
|
-
Set the
recordWarehouse
for aPopularityInsights
.For more details
For more information, see the asset CRUD snippets.