The Power of the Salesforce Report API

Are you utilizing the full potential of the Salesforce Report API? With ProgramMatek’s CCKM (CipherTrust Manager) integration, you can unleash the power of key-related activities between CCKM and Salesforce organizations. Salesforce supports the Key Activity Report, a comprehensive tool that enables you to dive deep into individual Salesforce tenant secrets’ histories and compare key activities between CCKM and Salesforce.

Generate, View, and Download Reports

The Salesforce Report API offers several key functionalities to help you manage and analyze your data effectively:

  • Generate a report
  • View the list of existing reports
  • View details of a specific report
  • Delete a report from CCKM
  • View the content of a generated report
  • Download the content of a report in CSV format

Let’s take a closer look at how each of these features can benefit your business.

Generating a Salesforce Cloud Report

To initiate report generation, use the post /v1/cckm/sfdc/reports API endpoint. This API kickstarts the report generation process. Check the content of the report by running the get /v1/cckm/sfdc/reports/{id}/contents API. For detailed instructions, refer to the section on Viewing Content of Generated Salesforce Cloud Reports.

See also  Google Flight API: A Look Back and an Alternative Solution

Syntax

AUTHTOKEN: string
name: string
report_type: string
sfdc_cloud_param: JSON
start_time: string
end_time: string

Example Request

Example Response

The output displays the current status of the report. Wait until the status changes to “Completed.” You can check the status by running the get /v1/cckm/sfdc/reports or get /v1/cckm/sfdc/reports/{id} API.

Viewing List of Existing Salesforce Cloud Reports

To get an overview of all your Salesforce cloud reports, utilize the get /v1/cckm/sfdc/reports API. This endpoint provides you with a comprehensive list of updated reports, which can be filtered using query parameters.

Syntax

AUTHTOKEN: string

Request Query Parameters

  • id: Internal ID of the Salesforce cloud report
  • overall_status: Overall status of the Salesforce cloud report (completed, in progress, failed)
  • name: Name of the Salesforce cloud report
  • report_type: Type of the Salesforce cloud report (key-report)
  • skip: Number of records to skip
  • limit: Number of records to display
  • sort: Comma-delimited list of properties to sort the results

Example Request

Example Response

The output displays a list of Salesforce cloud reports, including their details.

Viewing Details of a Particular Salesforce Cloud Report

Gain deeper insights into a specific Salesforce cloud report by using the get /v1/cckm/sfdc/reports/{id} API. This endpoint provides you with all the necessary details of the report in question.

Syntax

AUTHTOKEN: string

Example Request

Example Response

The output showcases the details of the specified Salesforce cloud report.

Viewing Content of Generated Salesforce Cloud Reports

To examine the content of a generated Salesforce cloud report, utilize the get /v1/cckm/sfdc/reports/{id}/contents API. This endpoint allows you to filter the content of the report using query parameters.

Syntax

AUTHTOKEN: string

Request Query Parameters

  • key_name: Name of the Salesforce tenant secret
  • key_type: Type of the Salesforce tenant secret
  • organization: Name of the Salesforce organization
  • cckm_operation: Operation performed from CCKM
  • user_name: Name of the CCKM user who performed the operation
  • version: Version of the Salesforce tenant secret
  • skip: Number of records to skip
  • limit: Number of records to display
  • sort: Comma-delimited list of properties to sort the results
See also  ProgramMatek - Exploring the Usajobs.gov API

Example Request

Example Response

Downloading Content of Salesforce Cloud Reports in CSV

To download the content of a Salesforce cloud report as a CSV file, use the get /v1/cckm/sfdc/reports/{id}/download API. The report will be downloaded as “{report-name}-{report-type}.csv,” for example, “sfdc-report-key-report.csv.”

Syntax

AUTHTOKEN: string

Example Request

The report will be downloaded as “{report-name}-{report-type}.csv,” for example, “sfdc-report-key-report.csv.”

Deleting a Report from CCKM

If you no longer require a specific Salesforce cloud report, you can delete it from CCKM using the delete /v1/cckm/sfdc/reports/{id} API.

Syntax

AUTHTOKEN: string

Example Request

Example Response

The output confirms the successful deletion of the specified report from CCKM.

Harness the full potential of the Salesforce Report API and elevate your data management and analysis capabilities. Start utilizing ProgramMatek’s CCKM integration today. For more information, visit ProgramMatek.