Dashboard Endpoints

dashboard-endpoints.md

Dashboard endpoints

/integration/{integrationType}/{integrationId}

• GET

  {
    customerId: string,
    installedAt: date,
    author: {name: string, email:string},
    isTranslationEnabled: boolean,
    defaultBaseLanguage: string,
    defaultNonTranslatable: string[],
    monthlyUsage: [{same_as_backstage_I_guess}, {}, {}],
    monthlyLimit: number,
    application: string,
    langStats: {[langIso]: number},
    totalCharacters: number, // this is an all time total for the integration
    totalConversations: number, // this is an all time total for the integration
    plan: { 
      id: 'pro' | 'trial' | 'free',
      period: {
        start: number,
        end: number,
      },
      valid: boolean,
    }

• PATCH

  {
    isTranslationEnabled: boolean,
    defaultBaseLanguage: string,
    defaultNonTranslatable: string[]
  }

/customer/{customer_id}/agents

• GET

  [{
    agent: {name: string, email: string},
    isSuperUser: boolean,
    baseLanguage: string,
    nonTranslatable: string[]
  }];

• PATCH

  [{
    isSuperUser: boolean,
    baseLanguage: string,
    nonTranslatable: string[]
  }];

/customer/{customer_id}/teams

• GET

  [{
    name: string,
    baseLanguage: string,
    nonTranslatable: string[]
  }];

• PATCH

  [{
    baseLanguage: string,
    nonTranslatable: string[]
  }];

/customer/{customer_id}/glossary

• POST CSV file
• GET CSV file contents in json (I guess)
• DELETE all content (json & CSV file, I guess)
• We should also be able to download the CSV file in its raw format