Skip to content

exportPrincipalsSummary

Export the user summary data.

Arguments

Argument Type Description
filter ExportPrincipalsSummaryFilterInput Filter to be applied when exporting principal summaries.
timelineDate (required) String! Date for which the results will be retrieved.
historicalDeltaDays (required) Int! Number of historical days to go backward in time to calculate the delta.

Returns

ExportPrincipalSummaryResp!

Sample

mutation ExportPrincipalsSummary($timelineDate: String!, $historicalDeltaDays: Int!) {
  exportPrincipalsSummary(
    timelineDate: $timelineDate
    historicalDeltaDays: $historicalDeltaDays
  ) {
    isSuccessful
  }
}

{
  "timelineDate": "example-string",
  "historicalDeltaDays": 0
}

{
  "data": {
    "exportPrincipalsSummary": {
      "isSuccessful": true
    }
  }
}