afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/AppAnalyticsQueryRequest.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "AppAnalyticsQueryRequest - Data API",
  "description": "Represents a request for AppExchange App Analytics data.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "AvailableSince": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort",
      "description": "An optional value used to limit the requested results file to data newly arrived in the data lake after the specified date and time. This field is always transferred in the Coordinated Universal Time (UTC) time zone. Use the AvailableSince field as part of your catch-up query strategy. AvailableSince must be later than StartTime and EndTime, if specified. AvailableSince must be earlier than now. A query must include StartTime,AvailableSince, or both. For example, to schedule a catch-up query on 2021-04-03T18:00:00Z for this date range: StartTime=2021-03-29T00:00:00Z EndTime=2021-03-30T00:00:00Z Valid AvailableSince values range from 2021-03-30T00:00:00Z to 2021-04-03T18:00:00Z. For more information on AvailableSince and catch-up queries, read AppExchange App Analytics Best Practices."
    },
    "DataType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "The type of usage data being requested. Valid values include: PackageUsageLog PackageUsageSummary SubscriberSnapshot Note: In Summer ’20, we changed the enum names from CustomObjectUsageSummary and CustomObjectUsageLog to PackageUsageSummary and PackageUsageLog. If you wrote integrations using CustomObjectUsageSummary or CustomObjectUsageLog, they continue to work only with v47 and earlier. After you upgrade to v48, you must update the DataType to PackageUsageSummary and PackageUsageLog."
    },
    "DownloadExpirationTime": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The time when the download URL is no longer valid. The expiration time is 60 minutes after the query is completed."
    },
    "DownloadSize": {
      "type": "long",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The size of the AppExchange App Analytics results file available for download, in bytes."
    },
    "DownloadUrl": {
      "type": "textarea",
      "properties": "Nillable",
      "description": "URL that the user can download data from. Populated after the request is completed. This URL expires and is removed after the expiration time is reached."
    },
    "EndTime": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort",
      "description": "Enter end time in format yyyy-MM-ddTHH:mm:ss. Example: 2019-04-15T12:00:00 For Package Usage Summaries, we recommend that StartTime corresponds to midnight UTC at beginning of the desired month and EndTime corresponds to midnight UTC at the beginning of the following month. For example, to retrieve the Package Usage Summary for December 2024 specify: StartTime=2024-12-01T00:00:00Z EndTime=2025-01-01T00:00:00Z"
    },
    "ErrorMessage": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Stores error message text that results from this query."
    },
    "FileCompression": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The file compression format of your requested results file. FileCompression and FileType must align. If FileType is csv, FileCompression defaults to none and can be none or gzip. If FileType is parquet, FileCompression is snappy by default and can be snappy, gzip, or none. Valid values include: gzip snappy none"
    },
    "FileType": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The data format of your requested results file. The default is csv. FileCompression and FileType must align. If FileType is csv, FileCompression defaults to none and can be none or gzip. If FileType is parquet, FileCompression is snappy by default and can be snappy, gzip, or none. Valid values include: csv parquet"
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed a record related to this record."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed."
    },
    "Name": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "The auto-generated name of the App Analytics query request."
    },
    "OrganizationIds": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "Optional. Enter up to 16 comma-separated org IDs without spaces between IDs. Or enter up to 15 comma-separated org IDs with spaces between the IDs. To request data for all the orgs the package is installed in, leave the field blank."
    },
    "PackageIds": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "Optional. Enter up to 16 comma-separated package IDs without spaces between IDs. Or enter up to 15 comma-separated package IDs with spaces between the IDs. Use the subscriber package ID that begins with 033. To retrieve a list of your second-generation managed package IDs, run sf package list --verbose in Salesforce CLI. To request data on all packages registered to this License Management App, leave the field blank."
    },
    "QuerySubmittedTime": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time that the App Analytics query request was received for processing, in Coordinated Universal Time (UTC). QuerySubmittedTime is read only."
    },
    "RequestState": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Status of the query request. Valid values are: New Pending Complete Expired Failed NoData"
    },
    "StartTime": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort",
      "description": "Enter start time in format yyyy-MM-ddTHH:mm:ss. All App Analytics query requests must include StartTime or AvailableSince or both.Example: 2019-04-14T12:00:00 For Package Usage Summaries, we recommend that StartTime corresponds to midnight UTC at beginning of the desired month and EndTime corresponds to midnight UTC at the beginning of the following month. For example, to retrieve the Package Usage Summary for December 2024 specify: StartTime=2024-12-01T00:00:00Z EndTime=2025-01-01T00:00:00Z"
    }
  },
  "special_access_rules": "See Get Started with AppExchange App Analytics in the Second-Generation Managed Packaging Developer Guide.",
  "usage": "To request usage data, log in to the License Management Org (LMO) that your package is registered to, and initiate the API request from the LMO. In a 24-hour period, you can download a maximum 20 GB of AppExchange App Analytics data. See Download Package Usage Logs, Package Usage Summaries, and Subscriber Snapshots in the Second Generation Managed Packaging Developer Guide. If requests to view package usage log or subscriber snapshot data are inactive for 90 days, we reserve the right to stop collecting this data. To resume data collection, log a support case in the Salesforce Partner Community. For product, specify Partner Programs & Benefits. For topic, specify ISV Technology Request.\n\nTo request usage data, log in to the License Management Org (LMO) that your package is registered to, and initiate the API request from the LMO. In a 24-hour period, you can download a maximum 20 GB of AppExchange App Analytics data.\n\nSee Download Package Usage Logs, Package Usage Summaries, and Subscriber Snapshots in the Second Generation Managed Packaging Developer Guide.\n\nIf requests to view package usage log or subscriber snapshot data are inactive for 90 days, we reserve the right to stop collecting this data. To resume data collection, log a support case in the Salesforce Partner Community. For product, specify Partner Programs & Benefits**. For topic, specify ISV Technology Request**.",
  "wsdl_segment": "```xml\n<complexType name=\"AppAnalyticsQueryRequest\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"AvailableSince\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"DataType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"DownloadExpirationTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"DownloadSize\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:long\"/>\n        <element name=\"DownloadUrl\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"EndTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"ErrorMessage\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FileCompression\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FileType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"OrganizationIds\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"PackageIds\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"QuerySubmittedTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"RequestState\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"StartTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n```",
  "field_reference": {
    "AvailableSince": {
      "field_label": "Available Since",
      "type": "datetime"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "DataType": {
      "field_label": "Data Type",
      "type": "picklist",
      "length": "255"
    },
    "DownloadExpirationTime": {
      "field_label": "Download Expiration Time",
      "type": "datetime"
    },
    "DownloadSize": {
      "field_label": "Download File Size",
      "type": "long",
      "digits": "18"
    },
    "DownloadUrl": {
      "field_label": "Download URL",
      "type": "textarea",
      "length": "8096"
    },
    "EndTime": {
      "field_label": "End Time",
      "type": "datetime"
    },
    "ErrorMessage": {
      "field_label": "Error Message",
      "type": "string",
      "length": "255"
    },
    "FileCompression": {
      "field_label": "File Compression",
      "type": "picklist",
      "length": "255"
    },
    "FileType": {
      "field_label": "File Type",
      "type": "picklist",
      "length": "255"
    },
    "Id": {
      "field_label": "App Analytics Query Request ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "Name": {
      "field_label": "Number",
      "type": "string",
      "length": "255"
    },
    "OrganizationIds": {
      "field_label": "Organization IDs",
      "type": "string",
      "length": "255"
    },
    "PackageIds": {
      "field_label": "Package IDs",
      "type": "string",
      "length": "255"
    },
    "QuerySubmittedTime": {
      "field_label": "Query Submitted Time",
      "type": "datetime"
    },
    "RequestState": {
      "field_label": "Request State",
      "type": "picklist",
      "length": "255"
    },
    "StartTime": {
      "field_label": "Start Time",
      "type": "datetime"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}