Skip to content

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:

  • Snippets — small, atomic examples of single-step use cases.
  • Patterns — walkthroughs of common multi-step implementation patterns.

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
builder.recordUser(...); // (1)
popularityInsights.getRecordUser(); // (2)

  1. Set the recordUser for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the recordUser from a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

recordQuery
Query run at source.
1
2
builder.recordQuery(...); // (1)
popularityInsights.getRecordQuery(); // (2)

  1. Set the recordQuery for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the recordQuery from a PopularityInsights.

    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
builder.recordQueryDuration(...); // (1)
popularityInsights.getRecordQueryDuration(); // (2)

  1. Set the recordQueryDuration for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the recordQueryDuration from a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

recordQueryCount
Number of queries run by the user.
1
2
builder.recordQueryCount(...); // (1)
popularityInsights.getRecordQueryCount(); // (2)

  1. Set the recordQueryCount for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the recordQueryCount from a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

recordTotalUserCount
Total number of users who ran queries.
1
2
builder.recordTotalUserCount(...); // (1)
popularityInsights.getRecordTotalUserCount(); // (2)

  1. Set the recordTotalUserCount for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the recordTotalUserCount from a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

recordComputeCost
Total compute cost for running all queries.
1
2
builder.recordComputeCost(...); // (1)
popularityInsights.getRecordComputeCost(); // (2)

  1. Set the recordComputeCost for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the recordComputeCost from a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

recordMaxComputeCost
Maximum compute cost across all query runs.
1
2
builder.recordMaxComputeCost(...); // (1)
popularityInsights.getRecordMaxComputeCost(); // (2)

  1. Set the recordMaxComputeCost for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the recordMaxComputeCost from a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

recordComputeCostUnit
Unit of measure for recordComputeCost.
1
2
builder.recordComputeCostUnit(...); // (1)
popularityInsights.getRecordComputeCostUnit(); // (2)

  1. Set the recordComputeCostUnit for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the recordComputeCostUnit from a PopularityInsights.

    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
builder.recordLastTimestamp(...); // (1)
popularityInsights.getRecordLastTimestamp(); // (2)

  1. Set the recordLastTimestamp for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the recordLastTimestamp from a PopularityInsights.

    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
builder.recordWarehouse(...); // (1)
popularityInsights.getRecordWarehouse(); // (2)

  1. Set the recordWarehouse for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the recordWarehouse from a PopularityInsights.

    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
{
  "attributes": {
    "recordUser": ... // (1)
  }
}

  1. Set the recordUser for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets.

recordQuery
Query run at source.
1
2
3
4
5
{
  "attributes": {
    "recordQuery": ... // (1)
  }
}

  1. Set the recordQuery for a PopularityInsights.

    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
{
  "attributes": {
    "recordQueryDuration": ... // (1)
  }
}

  1. Set the recordQueryDuration for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets.

recordQueryCount
Number of queries run by the user.
1
2
3
4
5
{
  "attributes": {
    "recordQueryCount": ... // (1)
  }
}

  1. Set the recordQueryCount for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets.

recordTotalUserCount
Total number of users who ran queries.
1
2
3
4
5
{
  "attributes": {
    "recordTotalUserCount": ... // (1)
  }
}

  1. Set the recordTotalUserCount for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets.

recordComputeCost
Total compute cost for running all queries.
1
2
3
4
5
{
  "attributes": {
    "recordComputeCost": ... // (1)
  }
}

  1. Set the recordComputeCost for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets.

recordMaxComputeCost
Maximum compute cost across all query runs.
1
2
3
4
5
{
  "attributes": {
    "recordMaxComputeCost": ... // (1)
  }
}

  1. Set the recordMaxComputeCost for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets.

recordComputeCostUnit
Unit of measure for recordComputeCost.
1
2
3
4
5
{
  "attributes": {
    "recordComputeCostUnit": ... // (1)
  }
}

  1. Set the recordComputeCostUnit for a PopularityInsights.

    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
{
  "attributes": {
    "recordLastTimestamp": ... // (1)
  }
}

  1. Set the recordLastTimestamp for a PopularityInsights.

    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
{
  "attributes": {
    "recordWarehouse": ... // (1)
  }
}

  1. Set the recordWarehouse for a PopularityInsights.

    For more details

    For more information, see the asset CRUD snippets.