> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ziplined.io/llms.txt
> Use this file to discover all available pages before exploring further.

# What worked this period



## OpenAPI

````yaml /openapi.json get /v1/insights
openapi: 3.1.0
info:
  title: Ziplined API
  version: 1.0.0
  description: >-
    LinkedIn engagement data about people, companies and posts. The workspace
    comes from the credential; lists page with `limit` and `next_cursor`.
servers:
  - url: https://api.ziplined.io
    description: Production
security: []
tags:
  - name: People
    description: The people in your workspace, and what you sent them.
  - name: Companies
    description: The companies those people work at.
  - name: Posts
    description: Your own posts and their numbers.
  - name: Engagements
    description: One act by one person on one post.
  - name: Insights
    description: Period against period, and the series behind it.
  - name: Audiences
    description: Named lists of people, and their membership.
  - name: Sources
    description: What your radar collects from.
  - name: Integrations
    description: Webhook and Slack destinations, and routing rules.
paths:
  /v1/insights:
    get:
      tags:
        - Insights
      summary: What worked this period
      parameters:
        - schema:
            type: integer
            description: The window, in days. Defaults to 30.
          required: false
          description: The window, in days. Defaults to 30.
          name: days
          in: query
        - schema:
            type: string
            description: Only these team members. Defaults to the whole team.
            example: NL,BE
          required: false
          description: Only these team members. Defaults to the whole team.
          name: person_id
          in: query
      responses:
        '200':
          description: The insights of this workspace over the window.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Insights'
                required:
                  - data
        '400':
          description: A filter value is invalid, or this resource has no such filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Wrong workspace, or the credential lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Insights:
      type: object
      properties:
        days:
          type: number
        lastSyncAt:
          type: string
          nullable: true
        icpEngagementChart:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              label:
                type: string
              icpCount:
                type: number
              totalCount:
                type: number
              icpRate:
                type: number
            required:
              - date
              - label
              - icpCount
              - totalCount
              - icpRate
            additionalProperties: false
        icpEngagementPrevChart:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              label:
                type: string
              icpCount:
                type: number
              totalCount:
                type: number
              icpRate:
                type: number
            required:
              - date
              - label
              - icpCount
              - totalCount
              - icpRate
            additionalProperties: false
        icpEngagementTrend:
          type: object
          properties:
            currentTotal:
              type: number
            previousTotal:
              type: number
            percentChange:
              type: number
              nullable: true
          required:
            - currentTotal
            - previousTotal
            - percentChange
          additionalProperties: false
        topIcpPosts:
          type: array
          items:
            type: object
            properties:
              postId:
                type: string
              contentPreview:
                type: string
              publishedAt:
                type: string
                nullable: true
              icpEngagementCount:
                type: number
              totalEngagementCount:
                type: number
              post_format:
                type: string
                nullable: true
              hook_type:
                type: string
                nullable: true
              cta_type:
                type: string
                nullable: true
              media_type:
                type: string
                nullable: true
              visual_type:
                type: string
                nullable: true
              isEnriched:
                type: boolean
            required:
              - postId
              - contentPreview
              - publishedAt
              - icpEngagementCount
              - totalEngagementCount
              - post_format
              - hook_type
              - cta_type
              - media_type
              - visual_type
              - isEnriched
            additionalProperties: false
        bottomIcpPosts:
          type: array
          items:
            type: object
            properties:
              postId:
                type: string
              contentPreview:
                type: string
              publishedAt:
                type: string
                nullable: true
              icpEngagementCount:
                type: number
              totalEngagementCount:
                type: number
              post_format:
                type: string
                nullable: true
              hook_type:
                type: string
                nullable: true
              cta_type:
                type: string
                nullable: true
              media_type:
                type: string
                nullable: true
              visual_type:
                type: string
                nullable: true
              isEnriched:
                type: boolean
            required:
              - postId
              - contentPreview
              - publishedAt
              - icpEngagementCount
              - totalEngagementCount
              - post_format
              - hook_type
              - cta_type
              - media_type
              - visual_type
              - isEnriched
            additionalProperties: false
        contentBreakdown:
          type: object
          properties:
            byFormat:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  avgIcpEngagement:
                    type: number
                  count:
                    type: number
                  posts:
                    type: array
                    items:
                      type: object
                      properties:
                        postId:
                          type: string
                        contentPreview:
                          type: string
                        publishedAt:
                          type: string
                          nullable: true
                        icpEngagementCount:
                          type: number
                        totalEngagementCount:
                          type: number
                        post_format:
                          type: string
                          nullable: true
                        hook_type:
                          type: string
                          nullable: true
                        cta_type:
                          type: string
                          nullable: true
                        media_type:
                          type: string
                          nullable: true
                        visual_type:
                          type: string
                          nullable: true
                        isEnriched:
                          type: boolean
                      required:
                        - postId
                        - contentPreview
                        - publishedAt
                        - icpEngagementCount
                        - totalEngagementCount
                        - post_format
                        - hook_type
                        - cta_type
                        - media_type
                        - visual_type
                        - isEnriched
                      additionalProperties: false
                required:
                  - label
                  - avgIcpEngagement
                  - count
                  - posts
                additionalProperties: false
            byHookType:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  avgIcpEngagement:
                    type: number
                  count:
                    type: number
                  posts:
                    type: array
                    items:
                      type: object
                      properties:
                        postId:
                          type: string
                        contentPreview:
                          type: string
                        publishedAt:
                          type: string
                          nullable: true
                        icpEngagementCount:
                          type: number
                        totalEngagementCount:
                          type: number
                        post_format:
                          type: string
                          nullable: true
                        hook_type:
                          type: string
                          nullable: true
                        cta_type:
                          type: string
                          nullable: true
                        media_type:
                          type: string
                          nullable: true
                        visual_type:
                          type: string
                          nullable: true
                        isEnriched:
                          type: boolean
                      required:
                        - postId
                        - contentPreview
                        - publishedAt
                        - icpEngagementCount
                        - totalEngagementCount
                        - post_format
                        - hook_type
                        - cta_type
                        - media_type
                        - visual_type
                        - isEnriched
                      additionalProperties: false
                required:
                  - label
                  - avgIcpEngagement
                  - count
                  - posts
                additionalProperties: false
            byCtaType:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  avgIcpEngagement:
                    type: number
                  count:
                    type: number
                  posts:
                    type: array
                    items:
                      type: object
                      properties:
                        postId:
                          type: string
                        contentPreview:
                          type: string
                        publishedAt:
                          type: string
                          nullable: true
                        icpEngagementCount:
                          type: number
                        totalEngagementCount:
                          type: number
                        post_format:
                          type: string
                          nullable: true
                        hook_type:
                          type: string
                          nullable: true
                        cta_type:
                          type: string
                          nullable: true
                        media_type:
                          type: string
                          nullable: true
                        visual_type:
                          type: string
                          nullable: true
                        isEnriched:
                          type: boolean
                      required:
                        - postId
                        - contentPreview
                        - publishedAt
                        - icpEngagementCount
                        - totalEngagementCount
                        - post_format
                        - hook_type
                        - cta_type
                        - media_type
                        - visual_type
                        - isEnriched
                      additionalProperties: false
                required:
                  - label
                  - avgIcpEngagement
                  - count
                  - posts
                additionalProperties: false
            byMediaType:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  avgIcpEngagement:
                    type: number
                  count:
                    type: number
                  posts:
                    type: array
                    items:
                      type: object
                      properties:
                        postId:
                          type: string
                        contentPreview:
                          type: string
                        publishedAt:
                          type: string
                          nullable: true
                        icpEngagementCount:
                          type: number
                        totalEngagementCount:
                          type: number
                        post_format:
                          type: string
                          nullable: true
                        hook_type:
                          type: string
                          nullable: true
                        cta_type:
                          type: string
                          nullable: true
                        media_type:
                          type: string
                          nullable: true
                        visual_type:
                          type: string
                          nullable: true
                        isEnriched:
                          type: boolean
                      required:
                        - postId
                        - contentPreview
                        - publishedAt
                        - icpEngagementCount
                        - totalEngagementCount
                        - post_format
                        - hook_type
                        - cta_type
                        - media_type
                        - visual_type
                        - isEnriched
                      additionalProperties: false
                required:
                  - label
                  - avgIcpEngagement
                  - count
                  - posts
                additionalProperties: false
            byVisualType:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  avgIcpEngagement:
                    type: number
                  count:
                    type: number
                  posts:
                    type: array
                    items:
                      type: object
                      properties:
                        postId:
                          type: string
                        contentPreview:
                          type: string
                        publishedAt:
                          type: string
                          nullable: true
                        icpEngagementCount:
                          type: number
                        totalEngagementCount:
                          type: number
                        post_format:
                          type: string
                          nullable: true
                        hook_type:
                          type: string
                          nullable: true
                        cta_type:
                          type: string
                          nullable: true
                        media_type:
                          type: string
                          nullable: true
                        visual_type:
                          type: string
                          nullable: true
                        isEnriched:
                          type: boolean
                      required:
                        - postId
                        - contentPreview
                        - publishedAt
                        - icpEngagementCount
                        - totalEngagementCount
                        - post_format
                        - hook_type
                        - cta_type
                        - media_type
                        - visual_type
                        - isEnriched
                      additionalProperties: false
                required:
                  - label
                  - avgIcpEngagement
                  - count
                  - posts
                additionalProperties: false
          required:
            - byFormat
            - byHookType
            - byCtaType
            - byMediaType
            - byVisualType
          additionalProperties: false
        audienceBreakdown:
          type: object
          properties:
            people:
              type: object
              properties:
                byCountry:
                  type: array
                  items:
                    type: object
                    properties:
                      label:
                        type: string
                      count:
                        type: number
                      icpCount:
                        type: number
                    required:
                      - label
                      - count
                      - icpCount
                    additionalProperties: false
                bySeniority:
                  type: array
                  items:
                    type: object
                    properties:
                      label:
                        type: string
                      count:
                        type: number
                      icpCount:
                        type: number
                    required:
                      - label
                      - count
                      - icpCount
                    additionalProperties: false
                byFollowers:
                  type: array
                  items:
                    type: object
                    properties:
                      label:
                        type: string
                      count:
                        type: number
                      icpCount:
                        type: number
                    required:
                      - label
                      - count
                      - icpCount
                    additionalProperties: false
              required:
                - byCountry
                - bySeniority
                - byFollowers
              additionalProperties: false
            companies:
              type: object
              properties:
                byIndustry:
                  type: array
                  items:
                    type: object
                    properties:
                      label:
                        type: string
                      count:
                        type: number
                      icpCount:
                        type: number
                    required:
                      - label
                      - count
                      - icpCount
                    additionalProperties: false
                byCompanySize:
                  type: array
                  items:
                    type: object
                    properties:
                      label:
                        type: string
                      count:
                        type: number
                      icpCount:
                        type: number
                    required:
                      - label
                      - count
                      - icpCount
                    additionalProperties: false
                withMultiple:
                  type: array
                  items:
                    type: object
                    properties:
                      company:
                        type: string
                      companyId:
                        type: string
                        nullable: true
                      people:
                        type: number
                      icpPeople:
                        type: number
                    required:
                      - company
                      - companyId
                      - people
                      - icpPeople
                    additionalProperties: false
              required:
                - byIndustry
                - byCompanySize
                - withMultiple
              additionalProperties: false
            coverage:
              type: object
              properties:
                people:
                  type: number
                withSeniority:
                  type: number
                withCountry:
                  type: number
                withFollowers:
                  type: number
                withCompany:
                  type: number
              required:
                - people
                - withSeniority
                - withCountry
                - withFollowers
                - withCompany
              additionalProperties: false
          required:
            - people
            - companies
            - coverage
          additionalProperties: false
        leadMomentum:
          type: object
          properties:
            connections:
              type: object
              properties:
                chart:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      label:
                        type: string
                      newCount:
                        type: number
                      cumulativeCount:
                        type: number
                    required:
                      - date
                      - label
                      - newCount
                      - cumulativeCount
                    additionalProperties: false
                prevChart:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      label:
                        type: string
                      newCount:
                        type: number
                      cumulativeCount:
                        type: number
                    required:
                      - date
                      - label
                      - newCount
                      - cumulativeCount
                    additionalProperties: false
                trend:
                  type: object
                  properties:
                    currentTotal:
                      type: number
                    previousTotal:
                      type: number
                    percentChange:
                      type: number
                      nullable: true
                  required:
                    - currentTotal
                    - previousTotal
                    - percentChange
                  additionalProperties: false
              required:
                - chart
                - prevChart
                - trend
              additionalProperties: false
            visits:
              type: object
              properties:
                chart:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      label:
                        type: string
                      newCount:
                        type: number
                      cumulativeCount:
                        type: number
                    required:
                      - date
                      - label
                      - newCount
                      - cumulativeCount
                    additionalProperties: false
                prevChart:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      label:
                        type: string
                      newCount:
                        type: number
                      cumulativeCount:
                        type: number
                    required:
                      - date
                      - label
                      - newCount
                      - cumulativeCount
                    additionalProperties: false
                trend:
                  type: object
                  properties:
                    currentTotal:
                      type: number
                    previousTotal:
                      type: number
                    percentChange:
                      type: number
                      nullable: true
                  required:
                    - currentTotal
                    - previousTotal
                    - percentChange
                  additionalProperties: false
              required:
                - chart
                - prevChart
                - trend
              additionalProperties: false
            followers:
              type: object
              properties:
                chart:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      label:
                        type: string
                      newCount:
                        type: number
                      cumulativeCount:
                        type: number
                    required:
                      - date
                      - label
                      - newCount
                      - cumulativeCount
                    additionalProperties: false
                prevChart:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                      label:
                        type: string
                      newCount:
                        type: number
                      cumulativeCount:
                        type: number
                    required:
                      - date
                      - label
                      - newCount
                      - cumulativeCount
                    additionalProperties: false
                trend:
                  type: object
                  properties:
                    currentTotal:
                      type: number
                    previousTotal:
                      type: number
                    percentChange:
                      type: number
                      nullable: true
                  required:
                    - currentTotal
                    - previousTotal
                    - percentChange
                  additionalProperties: false
              required:
                - chart
                - prevChart
                - trend
              additionalProperties: false
          required:
            - connections
            - visits
            - followers
          additionalProperties: false
        leadMix:
          type: object
          properties:
            newLeads:
              type: number
            returningLeads:
              type: number
          required:
            - newLeads
            - returningLeads
          additionalProperties: false
        topCompanies:
          type: array
          items:
            type: object
            properties:
              company:
                type: string
              companyId:
                type: string
                nullable: true
              leadCount:
                type: number
              icpLeadCount:
                type: number
              engagementCount:
                type: number
            required:
              - company
              - companyId
              - leadCount
              - icpLeadCount
              - engagementCount
            additionalProperties: false
        postingByDay:
          type: object
          properties:
            days:
              type: array
              items:
                type: object
                properties:
                  day:
                    type: string
                  avgLeads:
                    type: number
                  postCount:
                    type: number
                required:
                  - day
                  - avgLeads
                  - postCount
                additionalProperties: false
            totalPosts:
              type: number
            minPosts:
              type: number
            windowDays:
              type: number
          required:
            - days
            - totalPosts
            - minPosts
            - windowDays
          additionalProperties: false
        engagementTrackingStart:
          type: string
          nullable: true
        audienceTrackingStart:
          type: string
          nullable: true
        topicCloud:
          type: array
          items:
            type: object
            properties:
              text:
                type: string
              weight:
                type: number
              posts:
                type: array
                items:
                  type: object
                  properties:
                    postId:
                      type: string
                    contentPreview:
                      type: string
                    publishedAt:
                      type: string
                      nullable: true
                    icpEngagementCount:
                      type: number
                    totalEngagementCount:
                      type: number
                    post_format:
                      type: string
                      nullable: true
                    hook_type:
                      type: string
                      nullable: true
                    cta_type:
                      type: string
                      nullable: true
                    media_type:
                      type: string
                      nullable: true
                    visual_type:
                      type: string
                      nullable: true
                    isEnriched:
                      type: boolean
                  required:
                    - postId
                    - contentPreview
                    - publishedAt
                    - icpEngagementCount
                    - totalEngagementCount
                    - post_format
                    - hook_type
                    - cta_type
                    - media_type
                    - visual_type
                    - isEnriched
                  additionalProperties: false
            required:
              - text
              - weight
              - posts
            additionalProperties: false
        scatterData:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              engagement:
                type: number
              icpEngaged:
                type: number
              publishedAt:
                type: string
                nullable: true
              contentPreview:
                type: string
            required:
              - id
              - engagement
              - icpEngaged
              - publishedAt
              - contentPreview
            additionalProperties: false
        uniqueIcpEngagersChart:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              label:
                type: string
              newCount:
                type: number
              cumulativeCount:
                type: number
            required:
              - date
              - label
              - newCount
              - cumulativeCount
            additionalProperties: false
        uniqueIcpEngagersPrevChart:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              label:
                type: string
              newCount:
                type: number
              cumulativeCount:
                type: number
            required:
              - date
              - label
              - newCount
              - cumulativeCount
            additionalProperties: false
        uniqueIcpEngagersTrend:
          type: object
          properties:
            currentTotal:
              type: number
            previousTotal:
              type: number
            percentChange:
              type: number
              nullable: true
          required:
            - currentTotal
            - previousTotal
            - percentChange
          additionalProperties: false
        periodSummary:
          type: object
          properties:
            reached:
              type: number
            qualified:
              type: number
            repeat:
              type: number
          required:
            - reached
            - qualified
            - repeat
          additionalProperties: false
        periodStartDay:
          type: string
        teamMembers:
          type: array
          items:
            type: object
            properties:
              subjectId:
                type: string
              memberId:
                type: string
              name:
                type: string
            required:
              - subjectId
              - memberId
              - name
            additionalProperties: false
        selectedSubjectIds:
          type: array
          items:
            type: string
        teamResults:
          type: array
          items:
            type: object
            properties:
              subjectId:
                type: string
              memberId:
                type: string
              name:
                type: string
              people:
                type: number
              icpPeople:
                type: number
              engagements:
                type: number
              posts:
                type: number
            required:
              - subjectId
              - memberId
              - name
              - people
              - icpPeople
              - engagements
              - posts
            additionalProperties: false
        postingCadence:
          type: object
          properties:
            current:
              type: number
            previous:
              type: number
              nullable: true
          required:
            - current
            - previous
          additionalProperties: false
        repeatDistribution:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              people:
                type: number
              min:
                type: number
              max:
                type: number
                nullable: true
            required:
              - label
              - people
              - min
              - max
            additionalProperties: false
      required:
        - days
        - lastSyncAt
        - icpEngagementChart
        - icpEngagementPrevChart
        - icpEngagementTrend
        - topIcpPosts
        - bottomIcpPosts
        - contentBreakdown
        - audienceBreakdown
        - leadMomentum
        - leadMix
        - topCompanies
        - postingByDay
        - engagementTrackingStart
        - audienceTrackingStart
        - topicCloud
        - scatterData
        - uniqueIcpEngagersChart
        - uniqueIcpEngagersPrevChart
        - uniqueIcpEngagersTrend
        - periodSummary
        - periodStartDay
        - teamMembers
        - selectedSubjectIds
        - teamResults
        - postingCadence
        - repeatDistribution
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - error

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.