GET/api/v4/social/brands/{brandId}

Recupera un brand

Restituisce un brand social con i dettagli del profilo, il fuso orario, lo stato di archiviazione e il numero di canali collegati.

Richiede una chiave API. Consulta Autenticazione per il formato dell’header e la rotazione delle chiavi.

Parametri

Percorso

NomeTipoObbligatorioDescrizione
brandIdstringobbligatorioBrand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

Risposte

200The brand.
Response
{  "data": {    "getSocialProfileDetails": {      "id": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "profileName": "Jenny Home",      "archived": false,      "logo": "https://cdn.listingsapi.com/social/brands/6f2c9a41/logo.png",      "profileLogo": "https://cdn.listingsapi.com/social/brands/6f2c9a41/logo.png",      "siteUrl": "https://jennyhome.example",      "countryIso": "US",      "bio": "Handmade furniture for real homes.",      "businessIntent": "A family-run home furnishings store selling handmade furniture and textiles.",      "categories": ["Furniture Store", "Home Goods"],      "brandHashtags": ["jennyhome", "handmadefurniture"],      "competitorHashtags": ["localfurniture"],      "connectedChannelCount": 3,      "timezone": {        "label": "(GMT-05:00) Eastern Time",        "tzCode": "America/New_York",        "name": "Eastern Standard Time",        "utc": "-05:00"      },      "contentPreferredLanguage": "en"    }  }}
401Unauthenticated, missing or invalid API key.
404No brand with that ID on this account (`SY95043`).

Recupera un singolo brand tramite il suo UUID. Il payload è identico a una riga di GET /social/brands, quindi usa questa operazione quando hai già un brandId e vuoi la versione più aggiornata senza recuperare nuovamente l'elenco.

Caso d'uso: mostrare l'intestazione del brand in una schermata di pubblicazione. Leggi profileName e logo per assegnare un'etichetta all'editor del post e timezone.tzCode per visualizzare gli orari programmati nel fuso orario in cui l'API li interpreterà effettivamente. L'orario di un post programmato con scheduleDate + scheduleTime viene determinato in base a questo campo, quindi mostrare al lettore un valore diverso rischia di causare errori di diverse ore.

Caso d'uso: verifica preliminare prima della pubblicazione. Se connectedChannelCount è 0, non c'è alcun canale su cui pubblicare. Indirizza l'utente a un link di connessione invece di lasciargli comporre un post che verrà rifiutato con SY95045.

Note.

  • brandId è un semplice UUID. Codificarlo in Base64, come faresti con l'ID di una sede, produce un 404.
  • brandId è un token utilizzato solo nel percorso. Lo stesso valore compare nei corpi delle richieste come socialProfileId; i due nomi indicano lo stesso ID in posizioni diverse.
  • archived è true per un brand già archiviato. Per un brand la cui archiviazione è soltanto programmata, il valore resta archived: false: vedi archivia un brand.
  • timezone.tzCode è l'identificatore IANA in base al quale vengono interpretati gli orari programmati; gli altri tre campi relativi al fuso orario sono etichette di visualizzazione.
  • Per ottenere le singole connessioni del brand, con le rispettive piattaforme e gli ID di connessione, chiama GET /social/brands/{brandId}/connections.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>' \  -H "Authorization: API $LISTINGSAPI_KEY"