Is there any API to get Alerts data?

Kms
Kms Member
in APIs & Domo Developer

Instead of manually defining the Metric in the alert message I want to call the API to get all the metrics available on the given card for which I am receiving an alert.

To achieve this, I am listening to an alert webhook and wanted to check if I can make any API call that gives me all the metrics available with the Card.

Comments

  • MarkSnodgrass
    MarkSnodgrass Coach

    @GrantSmith is the king of API calls and may know if this is possible.

    **Check out my Domo Tips & Tricks Videos

    **Make sure to <3 any users posts that helped you.
    **Please mark as accepted the ones who solved your issue.
  • GrantSmith
    GrantSmith Coach

    @MarkSnodgrass you rang?

    @Kms

    https://INSTANCE.domo.com/api/social/v4/alerts/series?cardId=CARD_ID

    POST will return what's used to populate the alert modal. You'll need to play around with the body but should look something like:

    {"filterGroupIdArray":[ID_NUMBER]}

    I'd recommend monitoring the traffic for each card to see which ID it's using.

    **Was this post helpful? Click Agree or Like below**
    **Did this solve your problem? Accept it as a solution!**
  • Kms
    Kms Member

    Thanks @GrantSmith

    I was able to call API - /api/content/v3/cards/kpi/definition
    with a full authentication token. However, I am not able to call Https://INSTANCE.domo.com/api/social/v4/alerts/series?cardId=CARD_ID

    Can you please help me with which authentication token should be passed? Also, is there any documentation available for this API?

  • Kms
    Kms Member

    @GrantSmith I was able to access "api/social/v4/alerts?cardId=CARD_ID", It seems /series was not applicable.

    However, I am not able to get all the metric details, like RuleColumncurrentValue, RuleColumnPreviousValue, RuleColumnChangeInValue, etc.. which I was able to set in the webhook description. Is there any way I can get those details in the response as well?

    My use case is to pass a simple alert message in the webhook and based on that, fetch all the details possible of the metrics related to that alert.

  • Kms
    Kms Member

    Just to add in my previous question, is there any way I can get the card_id value in webhook body of the alert? I am able to get the name of the card on which alert is applied, but did not find any API to get card_id.

Categories