Get information about file

GET /files/{fileId}

Get information about file

cURL

curl --request GET \
  --url https://api.example.com/files/{fileId}

200

{
  "name": "<string>",
  "type": "UserAsset",
  "fileId": 1,
  "createdAt": 1,
  "mimeType": "<string>",
  "public": true,
  "recordId": 1,
  "fieldName": "<string>",
  "createdBy": 1,
  "sizeInBytes": 123,
  "signedUrl": "<string>",
  "posterSignedUrl": "<string>",
  "transcriptSignedUrl": "<string>",
  "sentimentAnalysisSignedUrl": "<string>",
  "summary": "<string>",
  "coachingAdvice": {
    "activeListening": {
      "rating": "<string>",
      "explanation": "<string>"
    },
    "questioningTechniques": {
      "rating": "<string>",
      "explanation": "<string>"
    },
    "handlingObjections": {
      "rating": "<string>",
      "explanation": "<string>"
    },
    "valuePropositionCommunication": {
      "rating": "<string>",
      "explanation": "<string>"
    },
    "closingTechniques": {
      "rating": "<string>",
      "explanation": "<string>"
    }
  },
  "salesFrameworkCoaching": {
    "bant": {
      "budget": {
        "score": 1,
        "points": [
          "<string>"
        ]
      },
      "authority": {
        "score": 1,
        "points": [
          "<string>"
        ]
      },
      "need": {
        "score": 1,
        "points": [
          "<string>"
        ]
      },
      "timeline": {
        "score": 1,
        "points": [
          "<string>"
        ]
      }
    },
    "meddic": {
      "metrics": {
        "score": 1,
        "points": [
          "<string>"
        ]
      },
      "economicBuyer": {
        "score": 1,
        "points": [
          "<string>"
        ]
      },
      "decisionCriteria": {
        "score": 1,
        "points": [
          "<string>"
        ]
      },
      "decisionProcess": {
        "score": 1,
        "points": [
          "<string>"
        ]
      },
      "identifyPain": {
        "score": 1,
        "points": [
          "<string>"
        ]
      },
      "champion": {
        "score": 1,
        "points": [
          "<string>"
        ]
      }
    }
  },
  "nextSteps": [
    {
      "title": "<string>",
      "points": [
        "<string>"
      ]
    }
  ],
  "confirmedActions": [
    {
      "title": "<string>",
      "goal": "<string>",
      "ownerOutsideCall": [
        "<string>"
      ],
      "when": "<string>",
      "ownerInCall": [
        1
      ]
    }
  ],
  "topTopics": [
    "<string>"
  ],
  "minutesRecordId": 1,
  "videoStatus": "GENERATING_FILE"
}

Path Parameters

fileId · string · required

Unique system identifier

Response

200

application/json

SDFile

File Data Response

name · string · required

Name of file

type · enum<string> · required

The type of file

Available options: UserAsset, Import

fileId · integer · required

ID of file

Required range: x >= 0

createdAt · integer · required

Required range: x >= 0

mimeType · string · required

Mime type of file

public · boolean

Whether anybody can access this file

recordId · integer

ID of record to which file is attached

Required range: x >= 0

fieldName · string

ID of record to which file is attached

Required string length: 1 - 10000

createdBy · integer

A User Id

Required range: x >= 0

sizeInBytes · number

Size of file in bytes

signedUrl · string

Signed URL of main file

posterSignedUrl · string

Signed URL of video poster image

transcriptSignedUrl · string

Signed URL of transcript file containing an array of TranscriptItem schema contents

sentimentAnalysisSignedUrl · string

Signed URL of sentiment analysis containing SentimentMap schema contents

summary · string

Summary of recording

coachingAdvice · Coaching advice · object

Coaching advice

Show child attributes

salesFrameworkCoaching · Sales Framework Coaching · object

Coaching feedback on sales frameworks implementation

Show child attributes

nextSteps · Next Steps · object[]

Suggested next steps

Show child attributes

confirmedActions · Confirmed Actions · object[]

Actions confirmed during a meeting or call

Option 1

Option 2

Show child attributes

topTopics · string[]

Top topics

minutesRecordId · integer

ID of minutes record

Required range: x >= 0

videoStatus · enum<string>

Status of video file

Available options: GENERATING_FILE, ANALYSIS_IN_PROGRESS, ANALYSIS_COMPLETE, ANALYSIS_SKIPPED