Get Feed Details

Feed: Get Feed Details

User Intent

"I want to retrieve full configuration details for a specific feed"

Operation

  • SDK Method: graphlit.getFeed()

  • GraphQL: getFeed query

  • Entity Type: Feed

  • Common Use Cases: View feed configuration, check OAuth tokens, inspect sync settings

TypeScript (Canonical)

import { Graphlit } from 'graphlit-client';
import { FeedTypes } from 'graphlit-client/dist/generated/graphql-types';

const graphlit = new Graphlit();

const feedId = 'feed-id-here';

// Get full feed details
const feed = await graphlit.getFeed(feedId);

console.log(`\nFeed: ${feed.feed.name}`);
console.log(`Type: ${feed.feed.type}`);
console.log(`State: ${feed.feed.state}`);
console.log(`Created: ${feed.feed.creationDate}`);

// Check type-specific configuration
switch (feed.feed.type) {
  case FeedTypes.Slack: {
    if (!feed.feed.slack) break;
    console.log(`\nSlack Configuration:`);
    console.log(`  Channels: ${feed.feed.slack.channels?.length ?? 0}`);
    feed.feed.slack.channels?.forEach((ch) => {
      console.log(`    - ${ch.name}`);
    });
    console.log(`  Read Messages: ${feed.feed.slack.readMessages}`);
    console.log(`  Read Threads: ${feed.feed.slack.readThreads}`);
    break;
  }
  case FeedTypes.Web: {
    if (!feed.feed.web) break;
    console.log(`\nWeb Configuration:`);
    console.log(`  Start URI: ${feed.feed.web.uri}`);
    console.log(`  Read Limit: ${feed.feed.web.readLimit}`);
    console.log(`  Include Files: ${feed.feed.web.includeFiles}`);
    console.log(`  Allowed Domains: ${feed.feed.web.allowedDomains?.join(', ')}`);
    break;
  }
  case FeedTypes.Rss: {
    if (!feed.feed.rss) break;
    console.log(`\nRSS Configuration:`);
    console.log(`  URI: ${feed.feed.rss.uri}`);
    console.log(`  Read Limit: ${feed.feed.rss.readLimit}`);
    break;
  }
  case FeedTypes.Google: {
    if (!feed.feed.google) break;
    console.log(`\nGoogle Drive Configuration:`);
    console.log(`  Folders: ${feed.feed.google.folderIds?.join(', ') ?? 'All'}`);
    console.log(`  Include Files: ${feed.feed.google.includeFiles}`);
    break;
  }
  case FeedTypes.MicrosoftTeams: {
    if (!feed.feed.microsoftTeams) break;
    console.log(`\nMicrosoft Teams Configuration:`);
    console.log(`  Team ID: ${feed.feed.microsoftTeams.teamId}`);
    console.log(`  Channel ID: ${feed.feed.microsoftTeams.channelId}`);
    console.log(`  Read Messages: ${feed.feed.microsoftTeams.readMessages}`);
    console.log(`  Read Threads: ${feed.feed.microsoftTeams.readThreads}`);
    break;
  }
  default: {
    console.log('\nNo specialized configuration for this feed type.');
  }
}

Get feed (snake_case)

feed = await graphlit.getFeed(feed_id)

print(f"Feed: {feed.feed.name}") print(f"Type: {feed.feed.type}") print(f"State: {feed.feed.state}")

Check Slack configuration

if feed.feed.type == "SLACK" and feed.feed.slack: print(f"Slack Channels: {len(feed.feed.slack.channels or [])}")

Parameters

  • id (string): Feed ID

Response

Developer Hints

Inspect Configuration

Check OAuth Token Status

Variations

1. Basic Feed Retrieval

2. Check Configuration

3. Verify Sync Settings

Production Example

Feed health check:

Last updated

Was this helpful?