---
schema_version: "1"
id: b9a5db20a76ba3fed79643296123de1c0d40b2527edbd6eb949d00bb2f853822
title: ConnectApi.CdpCalculatedInsightInput
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_connectapi_input_cdp_calculated_insight.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_input_cdp_calculated_insight.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 762b271465c6d9744a2e1ce97fc0f1476ea2f30f622df31314131cc5c6bd9f7d
description: Input representation for a calculated insight.
---
# ConnectApi.CdpCalculatedInsightInput

Input representation for a calculated insight.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d585007e27">Property</th>

              <th class="featureTableHeader vertical-align-top " id="d585007e30">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d585007e33">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d585007e36">Required or Optional</th>

              <th class="featureTableHeader vertical-align-top " id="d585007e39">Available Version</th>

            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property"><samp class="codeph apex_code">apiName</samp></td>
              <td class="entry" headers="d585007e30" data-title="Type">String</td>
              <td class="entry" headers="d585007e33" data-title="Description"><span class="ph" id="apiName"><a name="apiName"><!-- --></a>API name of the calculated insight with suffix __cio.</span></td>
              <td class="entry" headers="d585007e36" data-title="Required or Optional">Required for creating a calculated insight<p class="p">Optional for updating a calculated
                  insight</p>
              </td>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property">57.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property"><samp class="codeph apex_code">createdFrom​Package</samp></td>
              <td class="entry" headers="d585007e30" data-title="Type">Boolean</td>
              <td class="entry" headers="d585007e33" data-title="Description"><span class="ph" id="createdFromPackage"><a name="createdFromPackage"><!-- --></a>Specifies whether the calculated insight was created from an
                  installed package (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</span></td>
              <td class="entry" headers="d585007e36" data-title="Required or Optional">Optional</td>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property">57.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property"><samp class="codeph apex_code">dataSpaceName</samp></td>
              <td class="entry" headers="d585007e30" data-title="Type">String</td>
              <td class="entry" headers="d585007e33" data-title="Description"><span class="ph" id="dataSpaceName"><a name="dataSpaceName"><!-- --></a>Name of the data space.</span></td>
              <td class="entry" headers="d585007e36" data-title="Required or Optional">Optional</td>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property">57.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property"><samp class="codeph apex_code">definitionType</samp></td>
              <td class="entry" headers="d585007e30" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/connectAPI_enums.htm#calculatedInsightDefinitionTypeEnum"><samp class="codeph apex_code">ConnectApi.​CalculatedInsight​DefinitionTypeEnum</samp></a></td>
              <td class="entry" headers="d585007e33" data-title="Description">Definition type of the calculated insight. Values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph apex_code">CALCULATED_METRIC</samp></li>
                  <li class="li"><samp class="codeph apex_code">CALCULATED_METRIC</samp></li>
                  <li class="li"><samp class="codeph apex_code">CALCULATED_METRIC</samp></li>
                </ul>
              </td>
              <td class="entry" headers="d585007e36" data-title="Required or Optional">Required for creating a calculated insight<p class="p">Optional for updating a calculated
                  insight</p>
              </td>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property">57.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property"><samp class="codeph apex_code">description</samp></td>
              <td class="entry" headers="d585007e30" data-title="Type">String</td>
              <td class="entry" headers="d585007e33" data-title="Description"><span class="ph" id="description"><a name="description"><!-- --></a>Calculated insight description.</span></td>
              <td class="entry" headers="d585007e36" data-title="Required or Optional">Optional</td>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property">57.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property"><samp class="codeph apex_code">displayName</samp></td>
              <td class="entry" headers="d585007e30" data-title="Type">String</td>
              <td class="entry" headers="d585007e33" data-title="Description"><span class="ph" id="displayName"><a name="displayName"><!-- --></a>Calculated insight display name.</span></td>
              <td class="entry" headers="d585007e36" data-title="Required or Optional">Required for creating a calculated insight<p class="p">Optional for updating a calculated
                  insight</p>
              </td>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property">57.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property"><samp class="codeph apex_code">draft</samp></td>
              <td class="entry" headers="d585007e30" data-title="Type">Boolean</td>
              <td class="entry" headers="d585007e33" data-title="Description"><span class="ph" id="draft"><a name="draft"><!-- --></a>Specifies whether to save the calculated insight as draft (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</span></td>
              <td class="entry" headers="d585007e36" data-title="Required or Optional">Optional</td>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property">57.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property"><samp class="codeph apex_code">expression</samp></td>
              <td class="entry" headers="d585007e30" data-title="Type">String</td>
              <td class="entry" headers="d585007e33" data-title="Description"><span class="ph" id="expression"><a name="expression"><!-- --></a>Calculated insight ANSI SQL expression.</span></td>
              <td class="entry" headers="d585007e36" data-title="Required or Optional">Required for creating a calculated insight<p class="p">Optional for updating a calculated
                  insight</p>
              </td>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property">57.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property"><samp class="codeph apex_code">packagedCalculated​InsightApiName</samp></td>
              <td class="entry" headers="d585007e30" data-title="Type">String</td>
              <td class="entry" headers="d585007e33" data-title="Description"><span class="ph" id="packagedCalculatedInsightApiName"><a name="packagedCalculatedInsightApiName"><!-- --></a>API name of the packaged calculated
                  insight.</span></td>
              <td class="entry" headers="d585007e36" data-title="Required or Optional">Optional</td>
              <td class="entry" headers="d585007e27 d585007e39" data-title="Property">57.0</td>
            </tr>
          </tbody>
        </table>