PASnapshot - Scoped

The PASnapshot API allows you to query information about Performance Analytics snapshots.

You can query information about a snapshot at a certain date using the indicator sys_id and date, and perform comparisons between snapshots for an indicator at different dates.

PASnapshot - getCompareIDs(String sys_id, Number date1, Number date2, String type)

Compare records in snapshots for a specified indicator at multiple dates, such as to identify records included in one snapshot but not the other.

Table 1. Parameters
Name Type Description
sys_id String The indicator sys_id.
date1 Number The date of the first snapshot, in the format yyyymmdd.
date2 Number The date of the second snapshot, in the format yyyymmdd.
type String Specifies what data to retrieve. Valid values are:
  • all1: all records in the first snapshot
  • all2: all records in the second snapshot
  • shared: records that are in both snapshots
  • movedin: records that are in the second snapshot, but not the first
  • movedout: records that are in the first snapshot, but not the second
Table 2. Returns
Type Description
String A comma-separated list of sys_id values.
var snapshot2 = PASnapshot.getCompareIDs('fb007202d7130100b96d45a3ce6103b4', 20160430, 20160531, 'shared');
gs.info(snapshot2);

Output: *** Script: 09c01200d7002100b81145a3ce6103ab,19c01200d7002100b81145a3ce6103e9,fcc01200d7002100b81145a3ce61035b,….

PASnapshot - getCompareQuery(String sys_id, Number date1, Number date2, String type)

Get the query used to compare records in snapshots for a specified indicator at multiple dates.

Table 3. Parameters
Name Type Description
sys_id String The indicator sys_id.
date1 Number The date of the first snapshot, in the format yyyymmdd.
date2 Number The date of the second snapshot, in the format yyyymmdd.
type String Specifies what data to retrieve. Valid values are:
  • all1: all records in the first snapshot
  • all2: all records in the second snapshot
  • shared: records that are in both snapshots
  • movedin: records that are in the second snapshot, but not the first
  • movedout: records that are in the first snapshot, but not the second
Table 4. Returns
Type Description
String The table, view, and encoded query as a JSON string.
var snapshot4 = PASnapshot.getCompareQuery('fb007202d7130100b96d45a3ce6103b4', 20160530, 20160531, 'all1');
gs.info(snapshot4);

Output: *** Script: {"view":"","query":"sys_idINjavascript:new PAUtils().getCompareSnapshotIDs(\"fb007202d7130100b96d45a3ce6103b4\",\"20160530\",\"20160531\",\"all1\")","table":"incident"}

PASnapshot - getIDs(String sys_id, Number date)

Get the sys_id values for all records contained in the snapshot for a specified indicator at the specified date.

Table 5. Parameters
Name Type Description
sys_id String The indicator sys_id.
date Number The date when the snapshot was taken, in the format yyyymmdd.
Table 6. Returns
Type Description
String A comma-separated list of sys_id values.
var snapshot1 = PASnapshot.getIDs('fb007202d7130100b96d45a3ce6103b4', 20160530);
gs.info(snapshot1);

Output: *** Script: 09c01200d7002100b81145a3ce6103ab,19c01200d7002100b81145a3ce6103e9,fcc01200d7002100b81145a3ce61035b,….

PASnapshot - getQuery(String sys_id, Number date)

Get the query used to generate the snapshot for a specified indicator at the specified date.

Table 7. Parameters
Name Type Description
sys_id String The indicator sys_id.
date Number The date when the snapshot was taken, in the format yyyymmdd.
Table 8. Returns
Type Description
String The table, view, and encoded query as a JSON string.
var snapshot3 = PASnapshot.getQuery('fb007202d7130100b96d45a3ce6103b4', 20160530);
gs.info(snapshot3);

Output: *** Script: {"view":"","query":"sys_idINjavascript:new PAUtils().getSnapshotIDs(\"fb007202d7130100b96d45a3ce6103b4\",\"20160530\")","table":"incident"}