B2C CIP Skill

Use b2c cip commands to query B2C Commerce Intelligence (CIP), also known as Commerce Cloud Analytics (CCAC).

Tip: If b2c is not installed globally, use npx @salesforce/b2c-cli .

Command Structure

cip ├── tables - list metadata catalog tables ├── describe <table> - describe table columns ├── query - raw SQL execution └── report - curated report topic ├── sales-analytics ├── sales-summary ├── ocapi-requests ├── top-selling-products ├── product-co-purchase-analysis ├── promotion-discount-analysis ├── search-query-performance ├── payment-method-performance ├── customer-registration-trends └── top-referrers

Requirements

• OAuth client credentials: --client-id , --client-secret

• CIP tenant: --tenant-id (or --tenant )

• API client has Salesforce Commerce API role with tenant filter for your instance

Optional:

• --cip-host (or SFCC_CIP_HOST ) to override the default host

• --staging (or SFCC_CIP_STAGING ) to force staging analytics host

::: warning Availability This feature is typically used with production analytics tenants (for example abcd_prd ).

Starting with release 26.1, reports and dashboards data can also be enabled for non-production instances (ODS/dev/staging and designated test realms) using the Enable Reports & Dashboards Data Tracking feature switch.

Reports & Dashboards non-production URL: https://ccac.stg.analytics.commercecloud.salesforce.com

:::

Quick Workflow

• Discover available tables (b2c cip tables ) or curated reports (b2c cip report --help ).

• Use b2c cip describe <table> or report --describe to inspect structure/parameters.

• Use report --sql to preview generated SQL.

• Pipe SQL into cip query when you need custom execution/output handling.

Metadata Discovery Examples

List warehouse tables

b2c cip tables --tenant-id abcd_prd --client-id <client-id> --client-secret <client-secret>

Filter table names

b2c cip tables --tenant-id abcd_prd --pattern "ccdw_aggr_%" --client-id <client-id> --client-secret <client-secret>

Describe table columns

b2c cip describe ccdw_aggr_ocapi_request --tenant-id abcd_prd --client-id <client-id> --client-secret <client-secret>

Known Tables

For an efficient table catalog grouped by aggregate/dimension/fact families, use:

• references/KNOWN_TABLES.md

For a general-purpose starter query pack with ready-to-run SQL patterns, use:

• references/STARTER_QUERIES.md

The list is derived from official JDBC documentation and intended as a quick discovery aid.

Curated Report Examples

Show report commands

b2c cip report --help

Run a report

b2c cip report sales-analytics
--site-id Sites-RefArch-Site
--from 2025-01-01
--to 2025-01-31
--tenant-id abcd_prd
--client-id <client-id>
--client-secret <client-secret>

Show report parameter contract

b2c cip report top-referrers --describe

Print generated SQL and stop

b2c cip report top-referrers --site-id Sites-RefArch-Site --limit 25 --sql

Force staging analytics host

b2c cip report top-referrers --site-id Sites-RefArch-Site --limit 25 --staging --sql

SQL Pipeline Pattern

b2c cip report sales-analytics --site-id Sites-RefArch-Site --sql
| b2c cip query --tenant-id abcd_prd --client-id <client-id> --client-secret <client-secret>

Raw SQL Query Examples

b2c cip query
--tenant-id abcd_prd
--client-id <client-id>
--client-secret <client-secret>
"SELECT * FROM ccdw_aggr_sales_summary LIMIT 10"

You can also use:

• --file ./query.sql

• pipe query text from standard input (for example cat query.sql | b2c cip query ... )

Date Placeholders

b2c cip query supports placeholder replacement:

• <FROM> with --from YYYY-MM-DD

• <TO> with --to YYYY-MM-DD

• --from defaults to first day of current month

• --to defaults to today

If you provide --site-id , the common CIP format is Sites-{siteId}-Site . The command warns when siteId does not match that pattern but still runs with your input.

Output Formats

Both raw query and report commands support:

• --format table (default)

• --format csv

• --format json

• --json (global JSON mode)

Service Limits and Best Practices

The underlying JDBC analytics service has strict limits. Keep requests scoped:

• avoid broad SELECT * queries

• use narrow date ranges and incremental windows

• prefer aggregate tables when possible

• use report commands for common KPI workflows

Limits can change over time. Use the official JDBC access guide for current NFR limits:

• https://developer.salesforce.com/docs/commerce/pwa-kit-managed-runtime/guide/jdbc_access_guide.html

Troubleshooting

• tenant-id is required : set --tenant-id (or SFCC_TENANT_ID )

• Auth method error: CIP supports client credentials only; remove --user-auth

• 403/unauthorized: verify API client role and tenant filter include target instance

• Rate/timeout failures: reduce date window, select fewer columns, query aggregate tables

For full command reference, use b2c cip --help and CLI docs.